andesine 0.0.1-alpha.0

package/dist/shared/andesine.3cb4e565.d.cts

@@ -0,0 +1,458 @@
+import { d as PaginationParams, e as PaginationMeta, P as Profile, J as JSONContent, C as ContentPiece, f as ContentPiecesEndpoints, g as TagsEndpoints, h as ProfileEndpoints, A as APIFetcherConfig } from './andesine.5e4b2db8.cjs';
+
+interface ContentGroup {
+    /**
+     * Content group name
+     */
+    name: string;
+    /**
+     * Content group ID
+     */
+    id: string;
+    /**
+     * IDs of ancestor content groups, ordered from furthest to closest
+     */
+    ancestors: string[];
+    /**
+     * IDs of directly-descendant content groups
+     */
+    descendants: string[];
+}
+interface ContentGroupWithSubtree {
+    /**
+     * Content group name
+     */
+    name: string;
+    /**
+     * Content group ID
+     */
+    id: string;
+    /**
+     * IDs of ancestor content groups, ordered from furthest to closest
+     */
+    ancestors: string[];
+    /**
+     * Descendant content groups
+     */
+    descendants: ContentGroupWithSubtree[];
+}
+interface ContentGroupsEndpoints {
+    list<Subtree extends true | false = false>(input?: {
+        ancestor?: string;
+        subtree?: Subtree;
+    }): Promise<Subtree extends true ? ContentGroupWithSubtree[] : ContentGroup[]>;
+    get<Subtree extends true | false = false>(input: Pick<ContentGroup, "id"> & {
+        subtree?: Subtree;
+    }): Promise<Subtree extends true ? ContentGroupWithSubtree : ContentGroup>;
+    create(input: Omit<ContentGroup, "id" | "ancestors" | "descendants"> & {
+        ancestor?: string;
+    }): Promise<Pick<ContentGroup, "id">>;
+    update(input: Partial<Omit<ContentGroup, "ancestors" | "descendants">> & Pick<ContentGroup, "id">): Promise<void>;
+    update(input: Partial<Omit<ContentGroup, "ancestors" | "descendants" | "name">> & Pick<ContentGroup, "id"> & {
+        ancestor?: string;
+    }): Promise<void>;
+    delete(input: Pick<ContentGroup, "id">): Promise<void>;
+}
+
+type UIAccentColor = "energy" | "neon" | "sublime" | "sunrise" | "flow";
+interface UserSettings {
+    /**
+     * UI Theme
+     */
+    uiTheme: "light" | "dark" | "auto";
+    /**
+     * Code editor theme
+     */
+    codeEditorTheme: "light" | "dark" | "auto";
+    /**
+     * UI accent color
+     */
+    accentColor: UIAccentColor;
+}
+interface UserSettingsEndpoints {
+    get(): Promise<UserSettings>;
+    update(input: Partial<UserSettings>): Promise<void>;
+}
+
+type WebhookEvent = "contentPieceUpdated" | "contentPieceAdded" | "contentPieceRemoved" | "contentGroupAdded" | "contentGroupRemoved" | "memberInvited" | "memberAdded" | "memberRemoved";
+interface Webhook {
+    /**
+     * Webhook ID
+     */
+    id: string;
+    /**
+     * Webhook target URL
+     */
+    url: string;
+    /**
+     * Webhook name
+     */
+    name: string;
+    /**
+     * Webhook description
+     */
+    description?: string;
+    /**
+     * Webhook signing secret
+     */
+    secret?: string;
+    /**
+     * Webhook metadata containing details about the Webhook configuration
+     */
+    metadata?: {
+        contentGroupId: string;
+    };
+    /**
+     * Webhook trigger event
+     */
+    event: WebhookEvent;
+}
+interface WebhooksEndpoints {
+    get(input: Pick<Webhook, "id">): Promise<Omit<Webhook, "secret"> & {
+        extension?: boolean;
+    }>;
+    create(input: Omit<Webhook, "id">): Promise<Pick<Webhook, "id">>;
+    update(input: Partial<Omit<Webhook, "secret">> & Pick<Webhook, "id">): Promise<void>;
+    delete(query: Pick<Webhook, "id">): Promise<void>;
+    list(input: PaginationParams & {
+        extensionOnly?: boolean;
+    }): Promise<Array<Omit<Webhook, "secret"> & {
+        extension?: boolean;
+    }> & {
+        meta: {
+            pagination: PaginationMeta;
+        };
+    }>;
+}
+
+interface WorkspaceDetails {
+    /**
+     * Workspace ID
+     */
+    id: string;
+    /**
+     * Workspace name
+     */
+    name: string;
+    /**
+     * Workspace description
+     */
+    description?: string;
+    /**
+     * Workspace logo URL
+     */
+    logo?: string;
+}
+interface WorkspaceEndpoints {
+    get(): Promise<WorkspaceDetails>;
+}
+
+type RolePermission = "editContent" | "editSnippets" | "editMetadata" | "manageDashboard" | "manageTokens" | "manageWebhooks" | "manageWorkspace";
+type RoleBaseType = "admin" | "viewer";
+interface Role {
+    /**
+     * Role ID
+     */
+    id: string;
+    /**
+     * Role name
+     */
+    name: string;
+    /**
+     * Role description
+     */
+    description?: boolean;
+    /**
+     * Role permissions
+     */
+    permissions: RolePermission[];
+    /**
+     * Base role type (if applicable)
+     */
+    baseType?: RoleBaseType;
+}
+interface RolesEndpoints {
+    get(input: Pick<Role, "id">): Promise<Role>;
+    create(input: Omit<Role, "id" | "baseType">): Promise<Pick<Role, "id">>;
+    update(input: Partial<Omit<Role, "id" | "baseType">> & Pick<Role, "id">): Promise<void>;
+    delete(input: Pick<Role, "id">): Promise<void>;
+    list(input: PaginationParams): Promise<Role[] & {
+        meta: {
+            pagination: PaginationMeta;
+        };
+    }>;
+}
+
+type Mark = "bold" | "italic" | "strike" | "code" | "link" | "underline" | "highlight" | "subscript" | "superscript";
+type Block = "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "bulletList" | "orderedList" | "taskList" | "blockquote" | "codeBlock" | "horizontalRule" | "image" | "table" | "element";
+type Embed = "codepen" | "codesandbox" | "youtube";
+interface WorkspaceSettings {
+    /**
+     * Workspace settings ID
+     */
+    id: string;
+    /**
+     * JSON-stringified Prettier config
+     */
+    prettierConfig: string;
+    /**
+     * List of inline formatting marks enabled in the workspace
+     */
+    marks: Mark[];
+    /**
+     * List of content blocks enabled in the workspace
+     */
+    blocks: Block[];
+    /**
+     * List of embeds enabled in the workspace
+     */
+    embeds: Embed[];
+    /**
+     * Metadata settings
+     */
+    metadata?: Partial<{
+        canonicalLinkPattern: string;
+        enabledFields: Array<"date" | "tags" | "slug" | "filename" | "members" | "canonical-link">;
+    }>;
+    /**
+     * Dashboard views
+     */
+    dashboardViews?: {
+        table?: Array<{
+            id: string;
+            width: number;
+        }>;
+    };
+}
+interface WorkspaceSettingsEndpoints {
+    get(): Promise<WorkspaceSettings>;
+    update(input: Partial<Omit<WorkspaceSettings, "id">>): Promise<void>;
+}
+
+interface ListedMember {
+    /**
+     * Workspace membership ID
+     */
+    id: string;
+    /**
+     * ID of the user associated with the membership
+     */
+    userId?: string;
+    /**
+     * ID of the role assigned to the membership
+     */
+    roleId: string;
+    /**
+     * Email of the pending-invite user
+     */
+    email?: string;
+    /**
+     * Name of the pending-invite user
+     */
+    name?: string;
+    /**
+     * Whether the membership is a pending invite
+     */
+    pendingInvite: boolean;
+    /**
+     * Additional details about the profile of related user
+     */
+    profile?: Pick<Profile, "fullName" | "username" | "avatar">;
+}
+interface ListedWorkspace {
+    /**
+     * Workspace membership ID
+     */
+    id: string;
+    /**
+     * Additional details about the related workspace
+     */
+    workspace: WorkspaceDetails;
+    /**
+     * Additional details about the role assigned in the workspace
+     */
+    role?: Pick<Role, "id" | "name">;
+}
+interface WorkspaceMembershipsEndpoints {
+    listMembers(input: PaginationParams): Promise<ListedMember[] & {
+        meta: {
+            pagination: PaginationMeta;
+        };
+    }>;
+    listWorkspaces(input: PaginationParams): Promise<ListedWorkspace[] & {
+        meta: {
+            pagination: PaginationMeta;
+        };
+    }>;
+    create(input: {
+        email: string;
+        name: string;
+        roleId: string;
+    }): Promise<void>;
+    update(input: {
+        id: string;
+        roleId: string;
+    }): Promise<void>;
+    delete(input: {
+        id: string;
+    }): Promise<void>;
+}
+
+type ContextValue = string | number | boolean | ContextObject | ContextArray;
+interface ContextObject {
+    [x: string]: ContextValue;
+}
+interface ContextArray extends Array<ContextValue> {
+}
+interface Extension {
+    id: string;
+    name: string;
+    url: string;
+    config: ContextObject;
+    token: string;
+}
+interface ExtensionEndpoints {
+    get(): Promise<Partial<Extension>>;
+    getData(): Promise<ContextObject>;
+    updateData(input: {
+        data: ContextObject;
+    }): Promise<void>;
+    updateContentPieceData(input: {
+        contentPieceId: string;
+        data: ContextObject;
+    }): Promise<void>;
+}
+
+interface Variant {
+    /**
+     * Variant ID
+     */
+    id: string;
+    /**
+     * Variant key
+     */
+    key: string;
+    /**
+     * Variant label
+     */
+    label: string;
+    /**
+     * Variant description
+     */
+    description?: string;
+}
+interface VariantsEndpoints {
+    create(input: Omit<Variant, "id">): Promise<Pick<Variant, "id">>;
+    update(input: Partial<Variant> & Pick<Variant, "id">): Promise<void>;
+    delete(query: Pick<Variant, "id">): Promise<void>;
+    list(): Promise<Variant[]>;
+}
+
+interface RemoteTransformer {
+    /**
+     * Transformer ID
+     */
+    id: string;
+    /**
+     * Transformer label
+     */
+    label: string;
+    /**
+     * Transformer input URL
+     */
+    input: string;
+    /**
+     * Transformer output URL
+     */
+    output: string;
+    /**
+     * Transformer max batch size (1-1000)
+     */
+    maxBatchSize: number;
+}
+interface TransformersEndpoints {
+    create(input: Omit<RemoteTransformer, "id">): Promise<Pick<RemoteTransformer, "id">>;
+    delete(query: Pick<RemoteTransformer, "id">): Promise<void>;
+    list(): Promise<Array<RemoteTransformer & {
+        inUse?: boolean;
+    }>>;
+}
+
+type Snippet<IncludeContent extends true | false = false> = {
+    /**
+     * Snippet ID
+     */
+    id: string;
+    /**
+     * Name
+     */
+    name: string;
+} & (IncludeContent extends true ? {
+    /**
+     * JSON content
+     */
+    content: JSONContent;
+} : {});
+interface SnippetsEndpoints {
+    get<IncludeContent extends true | false = false>(input: Pick<Snippet, "id"> & {
+        content?: IncludeContent;
+    }): Promise<Snippet<IncludeContent>>;
+    create(input: Pick<Snippet, "name"> & {
+        content?: string;
+    }): Promise<Pick<Snippet, "id">>;
+    update(input: Partial<Pick<Snippet, "name"> & {
+        content?: string;
+    }> & Pick<Snippet, "id">): Promise<void>;
+    delete(input: Pick<Snippet, "id">): Promise<void>;
+    list<IncludeContent extends true | false = false>(input: {
+        content?: IncludeContent;
+    }): Promise<Array<Snippet<IncludeContent>>>;
+}
+
+interface SearchResult {
+    contentPieceId: string;
+    contentPiece: Omit<ContentPiece, "content" | "coverWidth">;
+    breadcrumb: string[];
+    content: string;
+}
+interface ClientConfig extends APIFetcherConfig {
+}
+interface Client {
+    contentGroups: ContentGroupsEndpoints;
+    contentPieces: ContentPiecesEndpoints;
+    snippets: SnippetsEndpoints;
+    tags: TagsEndpoints;
+    profile: ProfileEndpoints;
+    userSettings: UserSettingsEndpoints;
+    webhooks: WebhooksEndpoints;
+    workspace: WorkspaceEndpoints;
+    roles: RolesEndpoints;
+    workspaceSettings: WorkspaceSettingsEndpoints;
+    workspaceMemberships: WorkspaceMembershipsEndpoints;
+    extension: ExtensionEndpoints;
+    variants: VariantsEndpoints;
+    transformers: TransformersEndpoints;
+    search(input: {
+        query: string;
+        limit?: number;
+        variantId?: string;
+        contentGroupId?: string;
+        contentPieceId?: string;
+        byTitle?: boolean;
+    }): Promise<SearchResult[]>;
+    ask(input: {
+        query: string;
+        variantId?: string;
+        contentGroupId?: string;
+        contentPieceId?: string;
+        onChunk?(chunk: string, content: string): void;
+        onEnd?(content: string): void;
+        onError?(error: string): void;
+    }): void;
+    useSignal(signal: AbortSignal | null): Client;
+    reconfigure(config: ClientConfig): Client;
+    getConfig(): ClientConfig;
+}
+declare const createClient: (config: ClientConfig) => Client;
+
+export { type Block as B, type Client as C, type Embed as E, type ListedMember as L, type Mark as M, type Role as R, type SearchResult as S, type UIAccentColor as U, type Variant as V, type Webhook as W, type ContentGroup as a, type ContentGroupWithSubtree as b, createClient as c, type Snippet as d, type RoleBaseType as e, type RolePermission as f, type UserSettings as g, type WebhookEvent as h, type WorkspaceDetails as i, type WorkspaceSettings as j, type ListedWorkspace as k, type Extension as l };

package/dist/shared/andesine.5e4b2db8.d.cts

@@ -0,0 +1,201 @@
+interface APIFetcherConfig {
+    token: string;
+    baseURL?: string;
+    extensionId?: string;
+    headers?: Record<string, string>;
+}
+type PaginationParams = {
+    perPage?: number;
+    page?: number;
+};
+type PaginationMeta = {
+    total: number;
+    pages: number;
+    perPage: number;
+    page: number;
+};
+
+interface Profile {
+    /**
+     * User ID
+     */
+    id: string;
+    /**
+     * User avatar URL
+     */
+    avatar?: string;
+    /**
+     * Username
+     */
+    username: string;
+    /**
+     * User's personal bio
+     */
+    bio?: string;
+    /**
+     * User's full name
+     */
+    fullName?: string;
+    /**
+     * User's email
+     */
+    email: string;
+    /**
+     * Whether the user's new email is verified in the email change process
+     */
+    newEmailChangeInVerification?: boolean;
+    /**
+     * Whether the user's old email is verified in the email change process
+     */
+    oldEmailChangeInVerification?: boolean;
+    /**
+     * Whether the user's password is verified in the password change process
+     */
+    passwordChangeInVerification?: boolean;
+    /**
+     * Whether the user's email is verified
+     */
+    emailInVerification?: boolean;
+}
+interface ProfileEndpoints {
+    get(): Promise<Profile>;
+}
+
+type TagColor = "gray" | "red" | "pink" | "orange" | "amber" | "purple" | "indigo" | "blue" | "cyan" | "green" | "teal" | "lime" | "fuchsia" | "emerald";
+type Tag = {
+    /**
+     * Label describing the tag
+     */
+    label?: string;
+    /**
+     * Tag color
+     */
+    color: TagColor;
+    /**
+     * Tag ID
+     */
+    id: string;
+};
+interface TagsEndpoints {
+    get(input: Pick<Tag, "id">): Promise<Tag>;
+    update(input: Partial<Tag> & Pick<Tag, "id">): Promise<void>;
+    create(input: Omit<Tag, "id">): Promise<Pick<Tag, "id">>;
+    delete(input: Pick<Tag, "id">): Promise<void>;
+    list(input: PaginationParams): Promise<Tag[] & {
+        meta: {
+            pagination: PaginationMeta;
+        };
+    }>;
+}
+
+type JSONContentAttrs = Record<string, string | number | boolean>;
+type JSONContent = {
+    type: string;
+    content?: JSONContent[];
+    text?: string;
+    attrs?: JSONContentAttrs;
+    marks?: Array<{
+        type: string;
+        attrs: JSONContentAttrs;
+    }>;
+};
+type ContentPiece<CustomData extends Record<string, any> = Record<string, any>, IncludeContent extends true | false = false> = {
+    /**
+     * Content piece ID
+     */
+    id: string;
+    /**
+     * ISO date
+     */
+    date?: string | null;
+    /**
+     * Title
+     */
+    title: string;
+    /**
+     * Content piece description - can be HTML or plain text
+     */
+    description?: string | null;
+    /**
+     * URL of the cover image
+     */
+    coverUrl?: string | null;
+    /**
+     * Alt description of the cover image
+     */
+    coverAlt?: string | null;
+    /**
+     * ID of the content group to assign the piece to
+     */
+    contentGroupId: string;
+    /**
+     * JSON object containing custom metadata
+     */
+    customData?: CustomData | null;
+    /**
+     * Canonical link
+     */
+    canonicalLink?: string | null;
+    /**
+     * IDs of assigned tags
+     */
+    tags: string[];
+    /**
+     * IDs of assigned members
+     */
+    members: string[];
+    /**
+     * Content piece slug
+     */
+    slug: string;
+    /**
+     * Content piece filename
+     */
+    filename?: string | null;
+    /**
+     * Cover image width - percentage value string (only meant for resizing image inside Vrite editor)
+     */
+    coverWidth?: string;
+} & (IncludeContent extends true ? {
+    /**
+     * JSON content
+     */
+    content: JSONContent;
+} : {});
+type ContentPieceWithAdditionalData<CustomData extends Record<string, any> = Record<string, any>, IncludeContent extends true | false = false> = Omit<ContentPiece<CustomData, IncludeContent>, "tags" | "members"> & {
+    tags: Tag[];
+    members: Array<{
+        id: string;
+        profile: Omit<Profile, "bio">;
+    }>;
+};
+interface ContentPiecesEndpoints {
+    get<CustomData extends Record<string, any> = Record<string, any>, IncludeContent extends true | false = false>(input: Pick<ContentPiece, "id"> & {
+        content?: IncludeContent;
+        description?: "html" | "text";
+        variant?: string;
+    }): Promise<ContentPieceWithAdditionalData<CustomData, IncludeContent>>;
+    create<CustomData extends Record<string, any> = Record<string, any>>(input: Pick<ContentPiece<CustomData>, "date" | "title" | "description" | "tags" | "members" | "coverUrl" | "coverAlt" | "contentGroupId" | "customData" | "canonicalLink"> & {
+        referenceId?: string;
+        slug?: string;
+        content?: string;
+    }): Promise<Pick<ContentPiece<CustomData>, "id">>;
+    update<CustomData extends Record<string, any> = Record<string, any>>(input: Partial<Pick<ContentPiece<CustomData>, "date" | "title" | "description" | "tags" | "members" | "slug" | "coverUrl" | "coverAlt" | "contentGroupId" | "customData" | "canonicalLink" | "coverWidth"> & {
+        content?: string;
+        variant?: string;
+    }> & Pick<ContentPiece<CustomData>, "id">): Promise<void>;
+    delete(input: Pick<ContentPiece, "id">): Promise<void>;
+    list<CustomData extends Record<string, any> = Record<string, any>, IncludeContent extends true | false = false>(input: PaginationParams & {
+        content?: IncludeContent;
+        contentGroupId?: string | string[];
+        tagId?: string;
+        slug?: string;
+        variant?: string;
+    }): Promise<Array<ContentPieceWithAdditionalData<CustomData, IncludeContent>> & {
+        meta: {
+            pagination: PaginationMeta;
+        };
+    }>;
+}
+
+export type { APIFetcherConfig as A, ContentPiece as C, JSONContent as J, Profile as P, Tag as T, ContentPieceWithAdditionalData as a, JSONContentAttrs as b, TagColor as c, PaginationParams as d, PaginationMeta as e, ContentPiecesEndpoints as f, TagsEndpoints as g, ProfileEndpoints as h };