Documentation ¶
Index ¶
- Variables
- type AddDatasetSchemaParam
- type AddDynamicDatasetParam
- type AddDynamicDatasetSchemaParam
- type AddInfoboxFieldParam
- type AddLayerGroupInput
- type AddLayerItemInput
- type AddPropertyItemParam
- type Asset
- type AttachItemToGroupParam
- type Container
- type CreateAssetParam
- type CreateProjectParam
- type CreateTagGroupParam
- type CreateTagItemParam
- type Dataset
- type DetachItemToGroupParam
- type ImportDatasetFromGoogleSheetParam
- type ImportDatasetParam
- type ImportLayerParam
- type Layer
- type LinkPropertyValueParam
- type ListOperation
- type MoveInfoboxFieldParam
- type MoveLayerInput
- type MovePropertyItemParam
- type Plugin
- type Project
- type ProjectPublishedMetadata
- type Property
- type PublishProjectParam
- type Published
- type RemoveDatasetSchemaParam
- type RemoveInfoboxFieldParam
- type RemovePropertyFieldParam
- type RemovePropertyItemParam
- type Scene
- type SignupParam
- type Tag
- type Team
- type UnlinkPropertyValueParam
- type UpdateClusterParam
- type UpdateDatasetSchemaParam
- type UpdateLayerInput
- type UpdateMeParam
- type UpdateProjectParam
- type UpdatePropertyItemsOperationParam
- type UpdatePropertyItemsParam
- type UpdatePropertyValueParam
- type UpdateTagParam
- type UpdateWidgetAlignSystemParam
- type UpdateWidgetParam
- type UploadFileParam
- type User
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrSceneIsLocked error = errors.New("scene is locked") ErrOperationDenied error = errors.New("operation denied") ErrFileNotIncluded error = errors.New("file not included") )
View Source
var ( ErrNoDataSourceAvailable error = errors.New("no datasource available") ErrDataSourceInvalidURL error = errors.New("invalid url") ErrDatasetInvalidDepth error = errors.New("invalid depth") )
View Source
var ( ErrParentLayerNotFound error = errors.New("parent layer not found") ErrPluginNotFound error = errors.New("plugin not found") ErrExtensionNotFound error = errors.New("extension not found") ErrInfoboxNotFound error = errors.New("infobox not found") ErrInfoboxAlreadyExists error = errors.New("infobox already exists") ErrCannotAddLayerToLinkedLayerGroup error = errors.New("cannot add layer to linked layer group") ErrCannotRemoveLayerToLinkedLayerGroup error = errors.New("cannot remove layer to linked layer group") ErrLinkedLayerItemCannotBeMoved error = errors.New("linked layer item cannot be moved") ErrLayerCannotBeMovedToLinkedLayerGroup error = errors.New("layer cannot be moved to linked layer group") ErrCannotMoveLayerToOtherScene error = errors.New("layer cannot layer to other scene") ErrExtensionTypeMustBePrimitive error = errors.New("extension type must be primitive") ErrExtensionTypeMustBeBlock error = errors.New("extension type must be block") ErrInvalidExtensionType error = errors.New("invalid extension type") )
View Source
var ( ErrPluginAlreadyRegistered = errors.New("plugin already registered") ErrInvalidPluginPackage = errors.New("invalid plugin package") ErrCannotDeletePublicPlugin = errors.New("cannot delete public plugin") ErrCannotDeleteUsedPlugin = errors.New("cannot delete plugin used by at least one scene") )
View Source
var ( ErrProjectAliasIsNotSet error = errors.New("project alias is not set") ErrProjectAliasAlreadyUsed error = errors.New("project alias is already used by another project") )
View Source
var ( ErrPropertyNotFound error = errors.New("property not found") ErrPropertyInvalidType error = errors.New("property invalid type") ErrInvalidFile error = errors.New("invalid file") ErrFailedToUploadFile error = errors.New("failed to upload file") ErrPropertySchemaMustBeSpecified error = errors.New("property schema must be specified") ErrInvalidDatasetFieldID error = errors.New("invalid dataset field id") ErrInvalidPropertyLinks error = errors.New("invalid property links") ErrInvalidPropertyValue error = errors.New("invalid property value") )
View Source
var ( ErrPluginAlreadyInstalled error = errors.New("plugin already installed") ErrPluginNotInstalled error = errors.New("plugin not installed") ErrExtensionTypeMustBeWidget error = errors.New("extension type must be widget") )
View Source
var ( ErrOwnerCannotLeaveTheTeam = errors.New("owner user cannot leave from the team") ErrCannotChangeOwnerRole = errors.New("cannot change the role of the team owner") ErrCannotDeleteTeam = errors.New("cannot delete team because at least one project is left") )
View Source
var ( ErrUserInvalidPasswordConfirmation = errors.New("invalid password confirmation") ErrUserInvalidLang = errors.New("invalid lang") ErrSignupInvalidSecret = errors.New("invalid secret") )
View Source
var (
ErrCreateAssetFailed error = errors.New("failed to create asset")
)
View Source
var (
ErrNonemptyTagGroupCannotDelete = errors.New("can't delete non-empty tag group")
)
Functions ¶
This section is empty.
Types ¶
type AddDatasetSchemaParam ¶
type AddDatasetSchemaParam struct { SceneId id.SceneID Name string RepresentativeField *id.DatasetSchemaFieldID }
type AddDynamicDatasetParam ¶
type AddInfoboxFieldParam ¶
type AddLayerGroupInput ¶
type AddLayerGroupInput struct { ParentLayerID id.LayerID PluginID *id.PluginID ExtensionID *id.PluginExtensionID Index *int LinkedDatasetSchemaID *id.DatasetSchemaID RepresentativeFieldId *id.DatasetSchemaFieldID Name string }
type AddLayerItemInput ¶
type AddPropertyItemParam ¶
type Asset ¶
type Asset interface { Fetch(context.Context, []id.AssetID, *usecase.Operator) ([]*asset.Asset, error) FindByTeam(context.Context, id.TeamID, *usecase.Pagination, *usecase.Operator) ([]*asset.Asset, *usecase.PageInfo, error) Create(context.Context, CreateAssetParam, *usecase.Operator) (*asset.Asset, error) Remove(context.Context, id.AssetID, *usecase.Operator) (id.AssetID, error) }
type AttachItemToGroupParam ¶
type CreateProjectParam ¶
type CreateProjectParam struct { TeamID id.TeamID Visualizer visualizer.Visualizer Name *string Description *string ImageURL *url.URL Alias *string Archived *bool }
type CreateTagGroupParam ¶
type CreateTagItemParam ¶
type Dataset ¶
type Dataset interface { Fetch(context.Context, []id.DatasetID, *usecase.Operator) (dataset.List, error) GraphFetch(context.Context, id.DatasetID, int, *usecase.Operator) (dataset.List, error) FetchSchema(context.Context, []id.DatasetSchemaID, *usecase.Operator) (dataset.SchemaList, error) ImportDataset(context.Context, ImportDatasetParam, *usecase.Operator) (*dataset.Schema, error) ImportDatasetFromGoogleSheet(context.Context, ImportDatasetFromGoogleSheetParam, *usecase.Operator) (*dataset.Schema, error) GraphFetchSchema(context.Context, id.DatasetSchemaID, int, *usecase.Operator) (dataset.SchemaList, error) AddDynamicDatasetSchema(context.Context, AddDynamicDatasetSchemaParam) (*dataset.Schema, error) AddDynamicDataset(context.Context, AddDynamicDatasetParam) (*dataset.Schema, *dataset.Dataset, error) FindBySchema(context.Context, id.DatasetSchemaID, *usecase.Pagination, *usecase.Operator) (dataset.List, *usecase.PageInfo, error) FindSchemaByScene(context.Context, id.SceneID, *usecase.Pagination, *usecase.Operator) (dataset.SchemaList, *usecase.PageInfo, error) FindDynamicSchemaByScene(context.Context, id.SceneID) (dataset.SchemaList, error) RemoveDatasetSchema(context.Context, RemoveDatasetSchemaParam, *usecase.Operator) (id.DatasetSchemaID, error) UpdateDatasetSchema(context.Context, UpdateDatasetSchemaParam, *usecase.Operator) (*dataset.Schema, error) Sync(context.Context, id.SceneID, string, *usecase.Operator) (dataset.SchemaList, dataset.List, error) AddDatasetSchema(context.Context, AddDatasetSchemaParam, *usecase.Operator) (*dataset.Schema, error) }
type DetachItemToGroupParam ¶
type ImportDatasetParam ¶
type ImportLayerParam ¶
type Layer ¶
type Layer interface { Fetch(context.Context, []id.LayerID, *usecase.Operator) (layer.List, error) FetchGroup(context.Context, []id.LayerID, *usecase.Operator) ([]*layer.Group, error) FetchItem(context.Context, []id.LayerID, *usecase.Operator) ([]*layer.Item, error) FetchParent(context.Context, id.LayerID, *usecase.Operator) (*layer.Group, error) FetchByProperty(context.Context, id.PropertyID, *usecase.Operator) (layer.Layer, error) FetchMerged(context.Context, id.LayerID, *id.LayerID, *usecase.Operator) (*layer.Merged, error) FetchParentAndMerged(context.Context, id.LayerID, *usecase.Operator) (*layer.Merged, error) FetchByTag(context.Context, id.TagID, *usecase.Operator) (layer.List, error) AddItem(context.Context, AddLayerItemInput, *usecase.Operator) (*layer.Item, *layer.Group, error) AddGroup(context.Context, AddLayerGroupInput, *usecase.Operator) (*layer.Group, *layer.Group, error) Remove(context.Context, id.LayerID, *usecase.Operator) (id.LayerID, *layer.Group, error) Update(context.Context, UpdateLayerInput, *usecase.Operator) (layer.Layer, error) Move(context.Context, MoveLayerInput, *usecase.Operator) (id.LayerID, *layer.Group, *layer.Group, int, error) CreateInfobox(context.Context, id.LayerID, *usecase.Operator) (layer.Layer, error) RemoveInfobox(context.Context, id.LayerID, *usecase.Operator) (layer.Layer, error) AddInfoboxField(context.Context, AddInfoboxFieldParam, *usecase.Operator) (*layer.InfoboxField, layer.Layer, error) MoveInfoboxField(context.Context, MoveInfoboxFieldParam, *usecase.Operator) (id.InfoboxFieldID, layer.Layer, int, error) RemoveInfoboxField(context.Context, RemoveInfoboxFieldParam, *usecase.Operator) (id.InfoboxFieldID, layer.Layer, error) ImportLayer(context.Context, ImportLayerParam, *usecase.Operator) (layer.List, *layer.Group, error) AttachTag(context.Context, id.LayerID, id.TagID, *usecase.Operator) (layer.Layer, error) DetachTag(context.Context, id.LayerID, id.TagID, *usecase.Operator) (layer.Layer, error) }
type LinkPropertyValueParam ¶
type ListOperation ¶
type ListOperation string
const ( ListOperationAdd ListOperation = "add" ListOperationMove ListOperation = "move" ListOperationRemove ListOperation = "remove" )
type MoveInfoboxFieldParam ¶
type MoveInfoboxFieldParam struct { LayerID id.LayerID InfoboxFieldID id.InfoboxFieldID Index int }
type MoveLayerInput ¶
type MovePropertyItemParam ¶
type MovePropertyItemParam struct { PropertyID id.PropertyID Pointer *property.Pointer Index int }
type Plugin ¶
type Plugin interface { Fetch(context.Context, []id.PluginID, *usecase.Operator) ([]*plugin.Plugin, error) Upload(context.Context, io.Reader, id.SceneID, *usecase.Operator) (*plugin.Plugin, *scene.Scene, error) UploadFromRemote(context.Context, *url.URL, id.SceneID, *usecase.Operator) (*plugin.Plugin, *scene.Scene, error) Delete(context.Context, id.PluginID, *usecase.Operator) error FetchPluginMetadata(context.Context, *usecase.Operator) ([]*plugin.Metadata, error) }
type Project ¶
type Project interface { Fetch(context.Context, []id.ProjectID, *usecase.Operator) ([]*project.Project, error) FindByTeam(context.Context, id.TeamID, *usecase.Pagination, *usecase.Operator) ([]*project.Project, *usecase.PageInfo, error) Create(context.Context, CreateProjectParam, *usecase.Operator) (*project.Project, error) Update(context.Context, UpdateProjectParam, *usecase.Operator) (*project.Project, error) Publish(context.Context, PublishProjectParam, *usecase.Operator) (*project.Project, error) CheckAlias(context.Context, string) (bool, error) Delete(context.Context, id.ProjectID, *usecase.Operator) error }
type ProjectPublishedMetadata ¶
type ProjectPublishedMetadata struct { Title string `json:"title,omitempty"` Description string `json:"description,omitempty"` Image string `json:"image,omitempty"` Noindex bool `json:"noindex,omitempty"` IsBasicAuthActive bool `json:"isBasicAuthActive,omitempty"` BasicAuthUsername string `json:"basicAuthUsername,omitempty"` BasicAuthPassword string `json:"basicAuthPassword,omitempty"` }
func ProjectPublishedMetadataFrom ¶
func ProjectPublishedMetadataFrom(prj *project.Project) ProjectPublishedMetadata
type Property ¶
type Property interface { Fetch(context.Context, []id.PropertyID, *usecase.Operator) ([]*property.Property, error) FetchSchema(context.Context, []id.PropertySchemaID, *usecase.Operator) ([]*property.Schema, error) FetchMerged(context.Context, *id.PropertyID, *id.PropertyID, *id.DatasetID, *usecase.Operator) (*property.Merged, error) UpdateValue(context.Context, UpdatePropertyValueParam, *usecase.Operator) (*property.Property, *property.GroupList, *property.Group, *property.Field, error) RemoveField(context.Context, RemovePropertyFieldParam, *usecase.Operator) (*property.Property, error) UploadFile(context.Context, UploadFileParam, *usecase.Operator) (*property.Property, *property.GroupList, *property.Group, *property.Field, error) LinkValue(context.Context, LinkPropertyValueParam, *usecase.Operator) (*property.Property, *property.GroupList, *property.Group, *property.Field, error) UnlinkValue(context.Context, UnlinkPropertyValueParam, *usecase.Operator) (*property.Property, *property.GroupList, *property.Group, *property.Field, error) AddItem(context.Context, AddPropertyItemParam, *usecase.Operator) (*property.Property, *property.GroupList, *property.Group, error) MoveItem(context.Context, MovePropertyItemParam, *usecase.Operator) (*property.Property, *property.GroupList, *property.Group, error) RemoveItem(context.Context, RemovePropertyItemParam, *usecase.Operator) (*property.Property, error) UpdateItems(context.Context, UpdatePropertyItemsParam, *usecase.Operator) (*property.Property, error) }
type PublishProjectParam ¶
type PublishProjectParam struct { ID id.ProjectID Alias *string Status project.PublishmentStatus }
type RemoveDatasetSchemaParam ¶
type RemoveDatasetSchemaParam struct { SchemaId id.DatasetSchemaID Force *bool }
type RemoveInfoboxFieldParam ¶
type RemoveInfoboxFieldParam struct { LayerID id.LayerID InfoboxFieldID id.InfoboxFieldID }
type RemovePropertyFieldParam ¶
type RemovePropertyFieldParam struct { PropertyID id.PropertyID Pointer *property.Pointer }
type RemovePropertyItemParam ¶
type RemovePropertyItemParam struct { PropertyID id.PropertyID Pointer *property.Pointer }
type Scene ¶
type Scene interface { Fetch(context.Context, []id.SceneID, *usecase.Operator) ([]*scene.Scene, error) FindByProject(context.Context, id.ProjectID, *usecase.Operator) (*scene.Scene, error) FetchLock(context.Context, []id.SceneID, *usecase.Operator) ([]scene.LockMode, error) Create(context.Context, id.ProjectID, *usecase.Operator) (*scene.Scene, error) AddWidget(context.Context, id.SceneID, id.PluginID, id.PluginExtensionID, *usecase.Operator) (*scene.Scene, *scene.Widget, error) UpdateWidget(context.Context, UpdateWidgetParam, *usecase.Operator) (*scene.Scene, *scene.Widget, error) UpdateWidgetAlignSystem(context.Context, UpdateWidgetAlignSystemParam, *usecase.Operator) (*scene.Scene, error) RemoveWidget(context.Context, id.SceneID, id.WidgetID, *usecase.Operator) (*scene.Scene, error) InstallPlugin(context.Context, id.SceneID, id.PluginID, *usecase.Operator) (*scene.Scene, id.PluginID, *id.PropertyID, error) UninstallPlugin(context.Context, id.SceneID, id.PluginID, *usecase.Operator) (*scene.Scene, error) UpgradePlugin(context.Context, id.SceneID, id.PluginID, id.PluginID, *usecase.Operator) (*scene.Scene, error) AddCluster(context.Context, id.SceneID, string, *usecase.Operator) (*scene.Scene, *scene.Cluster, error) UpdateCluster(context.Context, UpdateClusterParam, *usecase.Operator) (*scene.Scene, *scene.Cluster, error) RemoveCluster(context.Context, id.SceneID, id.ClusterID, *usecase.Operator) (*scene.Scene, error) }
type SignupParam ¶
type Tag ¶
type Tag interface { Fetch(context.Context, []id.TagID, *usecase.Operator) ([]*tag.Tag, error) FetchByScene(context.Context, id.SceneID, *usecase.Operator) ([]*tag.Tag, error) FetchItem(context.Context, []id.TagID, *usecase.Operator) ([]*tag.Item, error) FetchGroup(context.Context, []id.TagID, *usecase.Operator) ([]*tag.Group, error) CreateItem(context.Context, CreateTagItemParam, *usecase.Operator) (*tag.Item, *tag.Group, error) CreateGroup(context.Context, CreateTagGroupParam, *usecase.Operator) (*tag.Group, error) AttachItemToGroup(context.Context, AttachItemToGroupParam, *usecase.Operator) (*tag.Group, error) DetachItemFromGroup(context.Context, DetachItemToGroupParam, *usecase.Operator) (*tag.Group, error) UpdateTag(context.Context, UpdateTagParam, *usecase.Operator) (*tag.Tag, error) Remove(context.Context, id.TagID, *usecase.Operator) (*id.TagID, layer.List, error) }
type Team ¶
type Team interface { Fetch(context.Context, []id.TeamID, *usecase.Operator) ([]*user.Team, error) FindByUser(context.Context, id.UserID, *usecase.Operator) ([]*user.Team, error) Create(context.Context, string, id.UserID) (*user.Team, error) Update(context.Context, id.TeamID, string, *usecase.Operator) (*user.Team, error) AddMember(context.Context, id.TeamID, id.UserID, user.Role, *usecase.Operator) (*user.Team, error) RemoveMember(context.Context, id.TeamID, id.UserID, *usecase.Operator) (*user.Team, error) UpdateMember(context.Context, id.TeamID, id.UserID, user.Role, *usecase.Operator) (*user.Team, error) Remove(context.Context, id.TeamID, *usecase.Operator) error }
type UnlinkPropertyValueParam ¶
type UnlinkPropertyValueParam struct { PropertyID id.PropertyID Pointer *property.Pointer }
type UpdateClusterParam ¶ added in v0.3.0
type UpdateDatasetSchemaParam ¶
type UpdateDatasetSchemaParam struct { SchemaId id.DatasetSchemaID Name string }
type UpdateLayerInput ¶
type UpdateMeParam ¶
type UpdateProjectParam ¶
type UpdateProjectParam struct { ID id.ProjectID Name *string Description *string Alias *string Archived *bool IsBasicAuthActive *bool BasicAuthUsername *string BasicAuthPassword *string ImageURL *url.URL PublicTitle *string PublicDescription *string PublicImage *string PublicNoIndex *bool DeletePublicImage bool DeleteImageURL bool }
type UpdatePropertyItemsOperationParam ¶
type UpdatePropertyItemsOperationParam struct { Operation ListOperation ItemID *id.PropertyItemID Index *int NameFieldValue *property.Value }
type UpdatePropertyItemsParam ¶
type UpdatePropertyItemsParam struct { PropertyID id.PropertyID Pointer *property.Pointer Operations []UpdatePropertyItemsOperationParam }
type UpdateTagParam ¶
type UpdateWidgetAlignSystemParam ¶
type UpdateWidgetAlignSystemParam struct { SceneID id.SceneID Location scene.WidgetLocation Align *scene.WidgetAlignType }
type UpdateWidgetParam ¶
type UploadFileParam ¶
type User ¶
type User interface { Fetch(context.Context, []id.UserID, *usecase.Operator) ([]*user.User, error) Signup(context.Context, SignupParam) (*user.User, *user.Team, error) UpdateMe(context.Context, UpdateMeParam, *usecase.Operator) (*user.User, error) RemoveMyAuth(context.Context, string, *usecase.Operator) (*user.User, error) SearchUser(context.Context, string, *usecase.Operator) (*user.User, error) DeleteMe(context.Context, id.UserID, *usecase.Operator) error }
Click to show internal directories.
Click to hide internal directories.