@webiny/api-aco 0.0.0-ee-vpcs.549378cf03

package/types.d.ts

@@ -0,0 +1,219 @@
+import { TenancyContext } from "@webiny/api-tenancy/types";
+import { Context as BaseContext } from "@webiny/handler/types";
+import { I18NContext } from "@webiny/api-i18n/types";
+import { SecurityContext, SecurityIdentity } from "@webiny/api-security/types";
+import { Topic } from "@webiny/pubsub/types";
+export interface CreatedBy {
+    id: string;
+    type: string;
+    displayName: string | null;
+}
+export interface ListMeta {
+    cursor: string | null;
+    totalCount: number;
+    hasMoreItems: boolean;
+}
+export interface Folder {
+    id: string;
+    name: string;
+    slug: string;
+    type: string;
+    parentId?: string;
+    createdOn: string;
+    createdBy: CreatedBy;
+    tenant: string;
+    locale: string;
+    webinyVersion: string;
+}
+export declare type FolderInput = Pick<Folder, "name" | "slug" | "type" | "parentId">;
+export interface GetFolderParams {
+    id: string;
+}
+export interface ListFoldersWhere {
+    type: string;
+}
+export interface ListFoldersParams {
+    where: ListFoldersWhere;
+}
+export interface CreateFolderParams {
+    folder: Folder;
+}
+export interface UpdateFolderParams {
+    original: Folder;
+    folder: Folder;
+}
+export interface DeleteFolderParams {
+    folder: Folder;
+}
+export interface StorageOperationsGetFolderParams {
+    id?: string;
+    slug?: string;
+    type?: string;
+    parentId?: string;
+    tenant: string;
+    locale: string;
+}
+export interface StorageOperationsListFoldersParams extends ListFoldersParams {
+    where: ListFoldersParams["where"] & {
+        tenant: string;
+        locale: string;
+    };
+    sort: string[];
+}
+export declare type StorageOperationsCreateFolderParams = CreateFolderParams;
+export declare type StorageOperationsUpdateFolderParams = UpdateFolderParams;
+export declare type StorageOperationsDeleteFolderParams = DeleteFolderParams;
+export interface OnFolderBeforeCreateTopicParams {
+    folder: Folder;
+}
+export interface OnFolderAfterCreateTopicParams {
+    folder: Folder;
+}
+export interface OnFolderBeforeUpdateTopicParams {
+    folder: Folder;
+    original: Folder;
+}
+export interface OnFolderAfterUpdateTopicParams {
+    folder: Folder;
+    original: Folder;
+}
+export interface OnFolderBeforeDeleteTopicParams {
+    folder: Folder;
+}
+export interface OnFolderAfterDeleteTopicParams {
+    folder: Folder;
+}
+export interface Link {
+    id: string;
+    linkId: string;
+    folderId: string;
+    createdOn: string;
+    createdBy: CreatedBy;
+    tenant: string;
+    locale: string;
+    webinyVersion: string;
+}
+export declare type LinkInput = Pick<Link, "id" | "folderId">;
+export interface ListLinksWhere {
+    folderId: string;
+}
+export interface ListLinksParams {
+    where: ListLinksWhere;
+    limit?: number;
+    after?: string | null;
+}
+export declare type ListLinksResponse = [Link[], ListMeta];
+export interface CreateLinkParams {
+    link: Link;
+}
+export interface UpdateLinkParams {
+    original: Link;
+    link: Link;
+}
+export interface DeleteLinkParams {
+    link: Link;
+}
+export interface DeleteLinksParams {
+    tenant: string;
+    locale: string;
+    folderIds: string[];
+}
+export interface StorageOperationsGetLinkParams {
+    id?: string;
+    folderId?: string;
+    tenant: string;
+    locale: string;
+}
+export interface StorageOperationsListLinksParams extends ListLinksParams {
+    where: ListLinksParams["where"] & {
+        tenant: string;
+        locale: string;
+    };
+    sort: string[];
+}
+export declare type StorageOperationListLinksResponse = ListLinksResponse;
+export declare type StorageOperationsCreateLinkParams = CreateLinkParams;
+export declare type StorageOperationsUpdateLinkParams = UpdateLinkParams;
+export declare type StorageOperationsDeleteLinkParams = DeleteLinkParams;
+export declare type StorageOperationsDeleteLinksParams = DeleteLinksParams;
+export interface OnLinkBeforeCreateTopicParams {
+    link: Link;
+}
+export interface OnLinkAfterCreateTopicParams {
+    link: Link;
+}
+export interface OnLinkBeforeUpdateTopicParams {
+    link: Link;
+    original: Link;
+}
+export interface OnLinkAfterUpdateTopicParams {
+    link: Link;
+    original: Link;
+}
+export interface OnLinkBeforeDeleteTopicParams {
+    link: Link;
+}
+export interface OnLinkAfterDeleteTopicParams {
+    link: Link;
+}
+export interface OnLinkBeforeDeleteBatchTopicParams {
+    folderIds: string[];
+}
+export interface OnLinkAfterDeleteBatchTopicParams {
+    folderIds: string[];
+}
+export interface ACOContext extends BaseContext, I18NContext, TenancyContext, SecurityContext {
+    folders: Folders;
+}
+export declare type Folders = IFolders & ILinks;
+export interface IFolders {
+    getFolder(params: GetFolderParams): Promise<Folder>;
+    listFolders(params: ListFoldersParams): Promise<Folder[]>;
+    createFolder(input: FolderInput): Promise<Folder>;
+    updateFolder(id: string, input: Partial<Folder>): Promise<Folder>;
+    deleteFolder(id: string): Promise<void>;
+    onFolderBeforeCreate: Topic<OnFolderBeforeCreateTopicParams>;
+    onFolderAfterCreate: Topic<OnFolderAfterCreateTopicParams>;
+    onFolderBeforeUpdate: Topic<OnFolderBeforeUpdateTopicParams>;
+    onFolderAfterUpdate: Topic<OnFolderAfterUpdateTopicParams>;
+    onFolderBeforeDelete: Topic<OnFolderBeforeDeleteTopicParams>;
+    onFolderAfterDelete: Topic<OnFolderAfterDeleteTopicParams>;
+}
+export interface ILinks {
+    getLink(id: string): Promise<Link>;
+    listLinks(params: ListLinksParams): Promise<ListLinksResponse>;
+    createLink(input: LinkInput): Promise<Link>;
+    updateLink(id: string, input: Partial<Link>): Promise<Link>;
+    deleteLink(id: string): Promise<void>;
+    deleteLinks(folderIds: string[]): Promise<void>;
+    onLinkBeforeCreate: Topic<OnLinkBeforeCreateTopicParams>;
+    onLinkAfterCreate: Topic<OnLinkAfterCreateTopicParams>;
+    onLinkBeforeUpdate: Topic<OnLinkBeforeUpdateTopicParams>;
+    onLinkAfterUpdate: Topic<OnLinkAfterUpdateTopicParams>;
+    onLinkBeforeDelete: Topic<OnLinkBeforeDeleteTopicParams>;
+    onLinkAfterDelete: Topic<OnLinkAfterDeleteTopicParams>;
+    onLinkBeforeDeleteBatch: Topic<OnLinkBeforeDeleteBatchTopicParams>;
+    onLinkAfterDeleteBatch: Topic<OnLinkAfterDeleteBatchTopicParams>;
+}
+export interface FoldersConfig {
+    getTenantId: () => string;
+    getLocaleCode: () => string;
+    getIdentity: () => SecurityIdentity;
+    storageOperations: StorageOperations;
+}
+export declare type StorageOperations = FoldersStorageOperations & LinksStorageOperations;
+export interface FoldersStorageOperations {
+    getFolder(params: StorageOperationsGetFolderParams): Promise<Folder | undefined>;
+    listFolders(params: StorageOperationsListFoldersParams): Promise<Folder[]>;
+    createFolder(params: StorageOperationsCreateFolderParams): Promise<Folder>;
+    updateFolder(params: StorageOperationsUpdateFolderParams): Promise<Folder>;
+    deleteFolder(params: StorageOperationsDeleteFolderParams): Promise<void>;
+}
+export interface LinksStorageOperations {
+    getLink(params: StorageOperationsGetLinkParams): Promise<Link | undefined>;
+    listLinks(params: StorageOperationsListLinksParams): Promise<StorageOperationListLinksResponse>;
+    createLink(params: StorageOperationsCreateLinkParams): Promise<Link>;
+    updateLink(params: StorageOperationsUpdateLinkParams): Promise<Link>;
+    deleteLink(params: StorageOperationsDeleteLinkParams): Promise<void>;
+    deleteLinks(params: StorageOperationsDeleteLinksParams): Promise<void>;
+}

package/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { TenancyContext } from \"@webiny/api-tenancy/types\";\nimport { Context as BaseContext } from \"@webiny/handler/types\";\nimport { I18NContext } from \"@webiny/api-i18n/types\";\nimport { SecurityContext, SecurityIdentity } from \"@webiny/api-security/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\n\nexport interface CreatedBy {\n    id: string;\n    type: string;\n    displayName: string | null;\n}\n\nexport interface ListMeta {\n    cursor: string | null;\n    totalCount: number;\n    hasMoreItems: boolean;\n}\n\nexport interface Folder {\n    id: string;\n    name: string;\n    slug: string;\n    type: string;\n    parentId?: string;\n    createdOn: string;\n    createdBy: CreatedBy;\n    tenant: string;\n    locale: string;\n    webinyVersion: string;\n}\n\nexport type FolderInput = Pick<Folder, \"name\" | \"slug\" | \"type\" | \"parentId\">;\n\nexport interface GetFolderParams {\n    id: string;\n}\n\nexport interface ListFoldersWhere {\n    type: string;\n}\n\nexport interface ListFoldersParams {\n    where: ListFoldersWhere;\n}\n\nexport interface CreateFolderParams {\n    folder: Folder;\n}\n\nexport interface UpdateFolderParams {\n    original: Folder;\n    folder: Folder;\n}\n\nexport interface DeleteFolderParams {\n    folder: Folder;\n}\n\nexport interface StorageOperationsGetFolderParams {\n    id?: string;\n    slug?: string;\n    type?: string;\n    parentId?: string;\n    tenant: string;\n    locale: string;\n}\n\nexport interface StorageOperationsListFoldersParams extends ListFoldersParams {\n    where: ListFoldersParams[\"where\"] & {\n        tenant: string;\n        locale: string;\n    };\n    sort: string[];\n}\n\nexport type StorageOperationsCreateFolderParams = CreateFolderParams;\nexport type StorageOperationsUpdateFolderParams = UpdateFolderParams;\nexport type StorageOperationsDeleteFolderParams = DeleteFolderParams;\n\nexport interface OnFolderBeforeCreateTopicParams {\n    folder: Folder;\n}\n\nexport interface OnFolderAfterCreateTopicParams {\n    folder: Folder;\n}\n\nexport interface OnFolderBeforeUpdateTopicParams {\n    folder: Folder;\n    original: Folder;\n}\n\nexport interface OnFolderAfterUpdateTopicParams {\n    folder: Folder;\n    original: Folder;\n}\n\nexport interface OnFolderBeforeDeleteTopicParams {\n    folder: Folder;\n}\n\nexport interface OnFolderAfterDeleteTopicParams {\n    folder: Folder;\n}\n\nexport interface Link {\n    id: string;\n    linkId: string;\n    folderId: string;\n    createdOn: string;\n    createdBy: CreatedBy;\n    tenant: string;\n    locale: string;\n    webinyVersion: string;\n}\n\nexport type LinkInput = Pick<Link, \"id\" | \"folderId\">;\n\nexport interface ListLinksWhere {\n    folderId: string;\n}\n\nexport interface ListLinksParams {\n    where: ListLinksWhere;\n    limit?: number;\n    after?: string | null;\n}\n\nexport type ListLinksResponse = [Link[], ListMeta];\n\nexport interface CreateLinkParams {\n    link: Link;\n}\n\nexport interface UpdateLinkParams {\n    original: Link;\n    link: Link;\n}\n\nexport interface DeleteLinkParams {\n    link: Link;\n}\n\nexport interface DeleteLinksParams {\n    tenant: string;\n    locale: string;\n    folderIds: string[];\n}\n\nexport interface StorageOperationsGetLinkParams {\n    id?: string;\n    folderId?: string;\n    tenant: string;\n    locale: string;\n}\n\nexport interface StorageOperationsListLinksParams extends ListLinksParams {\n    where: ListLinksParams[\"where\"] & {\n        tenant: string;\n        locale: string;\n    };\n    sort: string[];\n}\n\nexport type StorageOperationListLinksResponse = ListLinksResponse;\n\nexport type StorageOperationsCreateLinkParams = CreateLinkParams;\nexport type StorageOperationsUpdateLinkParams = UpdateLinkParams;\nexport type StorageOperationsDeleteLinkParams = DeleteLinkParams;\nexport type StorageOperationsDeleteLinksParams = DeleteLinksParams;\n\nexport interface OnLinkBeforeCreateTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkAfterCreateTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkBeforeUpdateTopicParams {\n    link: Link;\n    original: Link;\n}\n\nexport interface OnLinkAfterUpdateTopicParams {\n    link: Link;\n    original: Link;\n}\n\nexport interface OnLinkBeforeDeleteTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkAfterDeleteTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkBeforeDeleteBatchTopicParams {\n    folderIds: string[];\n}\n\nexport interface OnLinkAfterDeleteBatchTopicParams {\n    folderIds: string[];\n}\n\nexport interface ACOContext extends BaseContext, I18NContext, TenancyContext, SecurityContext {\n    folders: Folders;\n}\n\nexport type Folders = IFolders & ILinks;\n\nexport interface IFolders {\n    getFolder(params: GetFolderParams): Promise<Folder>;\n    listFolders(params: ListFoldersParams): Promise<Folder[]>;\n    createFolder(input: FolderInput): Promise<Folder>;\n    updateFolder(id: string, input: Partial<Folder>): Promise<Folder>;\n    deleteFolder(id: string): Promise<void>;\n    onFolderBeforeCreate: Topic<OnFolderBeforeCreateTopicParams>;\n    onFolderAfterCreate: Topic<OnFolderAfterCreateTopicParams>;\n    onFolderBeforeUpdate: Topic<OnFolderBeforeUpdateTopicParams>;\n    onFolderAfterUpdate: Topic<OnFolderAfterUpdateTopicParams>;\n    onFolderBeforeDelete: Topic<OnFolderBeforeDeleteTopicParams>;\n    onFolderAfterDelete: Topic<OnFolderAfterDeleteTopicParams>;\n}\n\nexport interface ILinks {\n    getLink(id: string): Promise<Link>;\n    listLinks(params: ListLinksParams): Promise<ListLinksResponse>;\n    createLink(input: LinkInput): Promise<Link>;\n    updateLink(id: string, input: Partial<Link>): Promise<Link>;\n    deleteLink(id: string): Promise<void>;\n    deleteLinks(folderIds: string[]): Promise<void>;\n    onLinkBeforeCreate: Topic<OnLinkBeforeCreateTopicParams>;\n    onLinkAfterCreate: Topic<OnLinkAfterCreateTopicParams>;\n    onLinkBeforeUpdate: Topic<OnLinkBeforeUpdateTopicParams>;\n    onLinkAfterUpdate: Topic<OnLinkAfterUpdateTopicParams>;\n    onLinkBeforeDelete: Topic<OnLinkBeforeDeleteTopicParams>;\n    onLinkAfterDelete: Topic<OnLinkAfterDeleteTopicParams>;\n    onLinkBeforeDeleteBatch: Topic<OnLinkBeforeDeleteBatchTopicParams>;\n    onLinkAfterDeleteBatch: Topic<OnLinkAfterDeleteBatchTopicParams>;\n}\n\nexport interface FoldersConfig {\n    getTenantId: () => string;\n    getLocaleCode: () => string;\n    getIdentity: () => SecurityIdentity;\n    storageOperations: StorageOperations;\n}\n\nexport type StorageOperations = FoldersStorageOperations & LinksStorageOperations;\n\nexport interface FoldersStorageOperations {\n    getFolder(params: StorageOperationsGetFolderParams): Promise<Folder | undefined>;\n    listFolders(params: StorageOperationsListFoldersParams): Promise<Folder[]>;\n    createFolder(params: StorageOperationsCreateFolderParams): Promise<Folder>;\n    updateFolder(params: StorageOperationsUpdateFolderParams): Promise<Folder>;\n    deleteFolder(params: StorageOperationsDeleteFolderParams): Promise<void>;\n}\n\nexport interface LinksStorageOperations {\n    getLink(params: StorageOperationsGetLinkParams): Promise<Link | undefined>;\n    listLinks(params: StorageOperationsListLinksParams): Promise<StorageOperationListLinksResponse>;\n    createLink(params: StorageOperationsCreateLinkParams): Promise<Link>;\n    updateLink(params: StorageOperationsUpdateLinkParams): Promise<Link>;\n    deleteLink(params: StorageOperationsDeleteLinkParams): Promise<void>;\n    deleteLinks(params: StorageOperationsDeleteLinksParams): Promise<void>;\n}\n"],"mappings":""}