andesine 0.0.1-alpha.0

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

@@ -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 };

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

@@ -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 };