@wix/autocms-folders-service 1.0.0

package/type-bundles/meta.bundle.d.ts

@@ -0,0 +1,499 @@
+/**
+ * Folder is a container for other folders and collection references
+ * There's always 1 root folder with empty ID
+ */
+interface Folder$1 {
+    /**
+     * unique ID, not present for root folder, mandatory for nested folders
+     * @readonly
+     */
+    id?: string | null;
+    /** display name */
+    displayName?: string;
+    /** folder description if any */
+    description?: string | null;
+    /** additional information */
+    info?: Record<string, any> | null;
+    /** collections in current folder */
+    collections?: CollectionReference$1[];
+    /** nested folders */
+    folders?: Folder$1[];
+}
+/**
+ * Reference to a collection, contained in a folder
+ * Collection may have up to 1 reference per folder
+ * and exactly 1 non-shortcut reference overall
+ */
+interface CollectionReference$1 {
+    /** collection unique name (ID) */
+    collectionName?: string;
+    /**
+     * same collection may have many shortcut references across folders
+     * but only one non-shortcut reference
+     * by default any collection will have reference at root folder
+     */
+    shortcut?: boolean;
+    /** additional information */
+    info?: Record<string, any> | null;
+}
+interface GetFolderRequest$1 {
+    /** missing means root */
+    folderId?: string | null;
+    /**
+     * nesting depth to return
+     * - 0 means no nested elements, only folder details
+     * - none means full folder tree
+     */
+    depth?: number | null;
+    /**
+     * if true CollectionReference.schema are not returned,
+     * but call is much faster.
+     * ignored for root folder request
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface GetFolderResponse$1 {
+    /** requested folder details */
+    folder?: Folder$1;
+    /** depth value requested */
+    depth?: number | null;
+}
+interface CreateFolderRequest$1 {
+    /** parent folder ID or none if root */
+    parentFolderId?: string | null;
+    /** folder info to create */
+    folderInfo?: FolderInfo$1;
+}
+interface FolderInfo$1 {
+    /** display name */
+    displayName?: string | null;
+    /** description */
+    description?: string | null;
+    /** additional info */
+    info?: Record<string, any> | null;
+}
+interface CreateFolderResponse$1 {
+    /** parent of created folder or none for root */
+    parentFolderId?: string | null;
+    /** created folder */
+    folder?: Folder$1;
+}
+interface UpdateFolderRequest$1 {
+    /** Folder ID */
+    folderId: string;
+    /** Fields to update, partial */
+    folderInfo?: FolderInfo$1;
+}
+interface UpdateFolderResponse$1 {
+    /**
+     * updated folder
+     * folder contents (folders and collections) would not be returned
+     */
+    folder?: Folder$1;
+}
+interface DeleteFolderRequest$1 {
+    /** folder ID to delete */
+    folderId: string;
+}
+interface DeleteFolderResponse$1 {
+}
+interface MoveFolderRequest$1 {
+    /** folder ID to move */
+    folderId: string;
+    /** destination folder ID (new parent), none if root */
+    parentFolderId?: string | null;
+}
+interface MoveFolderResponse$1 {
+}
+interface ReferenceCollectionRequest$1 {
+    /** collection name to reference (ID) */
+    collectionName: string;
+    /** target folder ID or none if root */
+    folderId?: string | null;
+    /**
+     * if false then single non-shortcut reference to this
+     * collection is moved to target folder
+     * otherwise new shortcut reference is created
+     */
+    shortcut?: boolean;
+    /**
+     * additional information for shortcut reference
+     * ignored for non-shortcut reference
+     */
+    info?: Record<string, any> | null;
+}
+interface ReferenceCollectionResponse$1 {
+    /** Folder ID that contains reference or none if root */
+    folderId?: string | null;
+    /** reference details */
+    collectionReference?: CollectionReference$1;
+}
+interface GetReferencesRequest$1 {
+    /** collection name (ID) to get */
+    collectionName: string;
+    /**
+     * if true schema would not be loaded and reference may not be found if collection is in root folder
+     * loading schema has performance impact
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface GetReferencesResponse$1 {
+    /** list of references */
+    references?: ReferenceLocation$1[];
+}
+interface ReferenceLocation$1 {
+    /** folder where reference is located */
+    folderId?: string | null;
+    /** reference details */
+    reference?: CollectionReference$1;
+}
+interface UpdateReferenceInfoRequest$1 {
+    /** folder where reference is located, none for root */
+    folderId?: string | null;
+    /** referenced collection name (ID) */
+    collectionName: string;
+    /** additional information to set */
+    info?: Record<string, any> | null;
+}
+interface UpdateReferenceInfoResponse$1 {
+    /** Folder ID that contains reference or none if root */
+    folderId?: string | null;
+    /** reference details */
+    collectionReference?: CollectionReference$1;
+}
+interface DeleteReferenceRequest$1 {
+    /** collection name (ID) to delete */
+    collectionName: string;
+    /** folder ID where to delete reference or none if root */
+    folderId?: string | null;
+}
+interface DeleteReferenceResponse$1 {
+}
+interface SearchRequest$1 {
+    /** Search string, matched ignoring case */
+    searchTerm?: string;
+}
+interface SearchResponse$1 {
+    /** folders found, no contents are returned */
+    folders?: Folder$1[];
+    /**
+     * collections found
+     * @deprecated
+     * @replacedBy references
+     * @targetRemovalDate 2025-01-01
+     */
+    collections?: CollectionReference$1[];
+    /** collection references found */
+    references?: ReferenceLocation$1[];
+}
+interface CollectionReferenceNonNullableFields$1 {
+    collectionName: string;
+    shortcut: boolean;
+}
+interface FolderNonNullableFields$1 {
+    displayName: string;
+    collections: CollectionReferenceNonNullableFields$1[];
+    folders: FolderNonNullableFields$1[];
+}
+interface GetFolderResponseNonNullableFields$1 {
+    folder?: FolderNonNullableFields$1;
+}
+interface CreateFolderResponseNonNullableFields$1 {
+    folder?: FolderNonNullableFields$1;
+}
+interface UpdateFolderResponseNonNullableFields$1 {
+    folder?: FolderNonNullableFields$1;
+}
+interface ReferenceCollectionResponseNonNullableFields$1 {
+    collectionReference?: CollectionReferenceNonNullableFields$1;
+}
+interface ReferenceLocationNonNullableFields$1 {
+    reference?: CollectionReferenceNonNullableFields$1;
+}
+interface GetReferencesResponseNonNullableFields$1 {
+    references: ReferenceLocationNonNullableFields$1[];
+}
+interface UpdateReferenceInfoResponseNonNullableFields$1 {
+    collectionReference?: CollectionReferenceNonNullableFields$1;
+}
+interface SearchResponseNonNullableFields$1 {
+    folders: FolderNonNullableFields$1[];
+    collections: CollectionReferenceNonNullableFields$1[];
+    references: ReferenceLocationNonNullableFields$1[];
+}
+
+/**
+ * Folder is a container for other folders and collection references
+ * There's always 1 root folder with empty ID
+ */
+interface Folder {
+    /**
+     * unique ID, not present for root folder, mandatory for nested folders
+     * @readonly
+     */
+    _id?: string | null;
+    /** display name */
+    displayName?: string;
+    /** folder description if any */
+    description?: string | null;
+    /** additional information */
+    info?: Record<string, any> | null;
+    /** collections in current folder */
+    collections?: CollectionReference[];
+    /** nested folders */
+    folders?: Folder[];
+}
+/**
+ * Reference to a collection, contained in a folder
+ * Collection may have up to 1 reference per folder
+ * and exactly 1 non-shortcut reference overall
+ */
+interface CollectionReference {
+    /** collection unique name (ID) */
+    collectionName?: string;
+    /**
+     * same collection may have many shortcut references across folders
+     * but only one non-shortcut reference
+     * by default any collection will have reference at root folder
+     */
+    shortcut?: boolean;
+    /** additional information */
+    info?: Record<string, any> | null;
+}
+interface GetFolderRequest {
+    /** missing means root */
+    folderId?: string | null;
+    /**
+     * nesting depth to return
+     * - 0 means no nested elements, only folder details
+     * - none means full folder tree
+     */
+    depth?: number | null;
+    /**
+     * if true CollectionReference.schema are not returned,
+     * but call is much faster.
+     * ignored for root folder request
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface GetFolderResponse {
+    /** requested folder details */
+    folder?: Folder;
+    /** depth value requested */
+    depth?: number | null;
+}
+interface CreateFolderRequest {
+    /** parent folder ID or none if root */
+    parentFolderId?: string | null;
+    /** folder info to create */
+    folderInfo?: FolderInfo;
+}
+interface FolderInfo {
+    /** display name */
+    displayName?: string | null;
+    /** description */
+    description?: string | null;
+    /** additional info */
+    info?: Record<string, any> | null;
+}
+interface CreateFolderResponse {
+    /** parent of created folder or none for root */
+    parentFolderId?: string | null;
+    /** created folder */
+    folder?: Folder;
+}
+interface UpdateFolderRequest {
+    /** Folder ID */
+    folderId: string;
+    /** Fields to update, partial */
+    folderInfo?: FolderInfo;
+}
+interface UpdateFolderResponse {
+    /**
+     * updated folder
+     * folder contents (folders and collections) would not be returned
+     */
+    folder?: Folder;
+}
+interface DeleteFolderRequest {
+    /** folder ID to delete */
+    folderId: string;
+}
+interface DeleteFolderResponse {
+}
+interface MoveFolderRequest {
+    /** folder ID to move */
+    folderId: string;
+    /** destination folder ID (new parent), none if root */
+    parentFolderId?: string | null;
+}
+interface MoveFolderResponse {
+}
+interface ReferenceCollectionRequest {
+    /** collection name to reference (ID) */
+    collectionName: string;
+    /** target folder ID or none if root */
+    folderId?: string | null;
+    /**
+     * if false then single non-shortcut reference to this
+     * collection is moved to target folder
+     * otherwise new shortcut reference is created
+     */
+    shortcut?: boolean;
+    /**
+     * additional information for shortcut reference
+     * ignored for non-shortcut reference
+     */
+    info?: Record<string, any> | null;
+}
+interface ReferenceCollectionResponse {
+    /** Folder ID that contains reference or none if root */
+    folderId?: string | null;
+    /** reference details */
+    collectionReference?: CollectionReference;
+}
+interface GetReferencesRequest {
+    /** collection name (ID) to get */
+    collectionName: string;
+    /**
+     * if true schema would not be loaded and reference may not be found if collection is in root folder
+     * loading schema has performance impact
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface GetReferencesResponse {
+    /** list of references */
+    references?: ReferenceLocation[];
+}
+interface ReferenceLocation {
+    /** folder where reference is located */
+    folderId?: string | null;
+    /** reference details */
+    reference?: CollectionReference;
+}
+interface UpdateReferenceInfoRequest {
+    /** folder where reference is located, none for root */
+    folderId?: string | null;
+    /** referenced collection name (ID) */
+    collectionName: string;
+    /** additional information to set */
+    info?: Record<string, any> | null;
+}
+interface UpdateReferenceInfoResponse {
+    /** Folder ID that contains reference or none if root */
+    folderId?: string | null;
+    /** reference details */
+    collectionReference?: CollectionReference;
+}
+interface DeleteReferenceRequest {
+    /** collection name (ID) to delete */
+    collectionName: string;
+    /** folder ID where to delete reference or none if root */
+    folderId?: string | null;
+}
+interface DeleteReferenceResponse {
+}
+interface SearchRequest {
+    /** Search string, matched ignoring case */
+    searchTerm?: string;
+}
+interface SearchResponse {
+    /** folders found, no contents are returned */
+    folders?: Folder[];
+    /**
+     * collections found
+     * @deprecated
+     * @replacedBy references
+     * @targetRemovalDate 2025-01-01
+     */
+    collections?: CollectionReference[];
+    /** collection references found */
+    references?: ReferenceLocation[];
+}
+interface CollectionReferenceNonNullableFields {
+    collectionName: string;
+    shortcut: boolean;
+}
+interface FolderNonNullableFields {
+    displayName: string;
+    collections: CollectionReferenceNonNullableFields[];
+    folders: FolderNonNullableFields[];
+}
+interface GetFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+interface CreateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+interface UpdateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+interface ReferenceCollectionResponseNonNullableFields {
+    collectionReference?: CollectionReferenceNonNullableFields;
+}
+interface ReferenceLocationNonNullableFields {
+    reference?: CollectionReferenceNonNullableFields;
+}
+interface GetReferencesResponseNonNullableFields {
+    references: ReferenceLocationNonNullableFields[];
+}
+interface UpdateReferenceInfoResponseNonNullableFields {
+    collectionReference?: CollectionReferenceNonNullableFields;
+}
+interface SearchResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+    collections: CollectionReferenceNonNullableFields[];
+    references: ReferenceLocationNonNullableFields[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getFolder(): __PublicMethodMetaInfo<'GET', {}, GetFolderRequest, GetFolderRequest$1, GetFolderResponse & GetFolderResponseNonNullableFields, GetFolderResponse$1 & GetFolderResponseNonNullableFields$1>;
+declare function createFolder(): __PublicMethodMetaInfo<'POST', {}, CreateFolderRequest, CreateFolderRequest$1, CreateFolderResponse & CreateFolderResponseNonNullableFields, CreateFolderResponse$1 & CreateFolderResponseNonNullableFields$1>;
+declare function updateFolder(): __PublicMethodMetaInfo<'PATCH', {
+    folderId: string;
+}, UpdateFolderRequest, UpdateFolderRequest$1, UpdateFolderResponse & UpdateFolderResponseNonNullableFields, UpdateFolderResponse$1 & UpdateFolderResponseNonNullableFields$1>;
+declare function deleteFolder(): __PublicMethodMetaInfo<'DELETE', {
+    folderId: string;
+}, DeleteFolderRequest, DeleteFolderRequest$1, DeleteFolderResponse, DeleteFolderResponse$1>;
+declare function moveFolder(): __PublicMethodMetaInfo<'POST', {
+    folderId: string;
+}, MoveFolderRequest, MoveFolderRequest$1, MoveFolderResponse, MoveFolderResponse$1>;
+declare function referenceCollection(): __PublicMethodMetaInfo<'POST', {}, ReferenceCollectionRequest, ReferenceCollectionRequest$1, ReferenceCollectionResponse & ReferenceCollectionResponseNonNullableFields, ReferenceCollectionResponse$1 & ReferenceCollectionResponseNonNullableFields$1>;
+declare function getReferences(): __PublicMethodMetaInfo<'POST', {}, GetReferencesRequest, GetReferencesRequest$1, GetReferencesResponse & GetReferencesResponseNonNullableFields, GetReferencesResponse$1 & GetReferencesResponseNonNullableFields$1>;
+declare function updateReferenceInfo(): __PublicMethodMetaInfo<'POST', {}, UpdateReferenceInfoRequest, UpdateReferenceInfoRequest$1, UpdateReferenceInfoResponse & UpdateReferenceInfoResponseNonNullableFields, UpdateReferenceInfoResponse$1 & UpdateReferenceInfoResponseNonNullableFields$1>;
+declare function deleteReference(): __PublicMethodMetaInfo<'POST', {}, DeleteReferenceRequest, DeleteReferenceRequest$1, DeleteReferenceResponse, DeleteReferenceResponse$1>;
+declare function search(): __PublicMethodMetaInfo<'POST', {}, SearchRequest, SearchRequest$1, SearchResponse & SearchResponseNonNullableFields, SearchResponse$1 & SearchResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_createFolder: typeof createFolder;
+declare const meta_deleteFolder: typeof deleteFolder;
+declare const meta_deleteReference: typeof deleteReference;
+declare const meta_getFolder: typeof getFolder;
+declare const meta_getReferences: typeof getReferences;
+declare const meta_moveFolder: typeof moveFolder;
+declare const meta_referenceCollection: typeof referenceCollection;
+declare const meta_search: typeof search;
+declare const meta_updateFolder: typeof updateFolder;
+declare const meta_updateReferenceInfo: typeof updateReferenceInfo;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createFolder as createFolder, meta_deleteFolder as deleteFolder, meta_deleteReference as deleteReference, meta_getFolder as getFolder, meta_getReferences as getReferences, meta_moveFolder as moveFolder, meta_referenceCollection as referenceCollection, meta_search as search, meta_updateFolder as updateFolder, meta_updateReferenceInfo as updateReferenceInfo };
+}
+
+export { meta as autocms };