@plasmicpkgs/plasmic-cms 0.0.284 → 0.0.286

package/dist/index.d.ts

@@ -1,8 +1,254 @@
-import registerComponent from "@plasmicapp/host/registerComponent";
-import registerGlobalContext from "@plasmicapp/host/registerGlobalContext";
-export declare function registerAll(loader?: {
-    registerComponent: typeof registerComponent;
-    registerGlobalContext: typeof registerGlobalContext;
-}): void;
-export * from "./api";
-export * from "./components";
+import { ApiCmsRow as ApiCmsRow_2 } from './schema';
+import { ApiCmsTable as ApiCmsTable_2 } from './schema';
+import { CanvasComponentProps } from '@plasmicapp/host/registerComponent';
+import { ComponentMeta } from '@plasmicapp/host/registerComponent';
+import { GlobalContextMeta } from '@plasmicapp/host/registerGlobalContext';
+import { default as React_2 } from 'react';
+import registerComponent from '@plasmicapp/host/registerComponent';
+import registerGlobalContext from '@plasmicapp/host/registerGlobalContext';
+
+export declare class API {
+    private config;
+    constructor(config: DatabaseConfig);
+    get(endpoint: string, params?: any): Promise<any>;
+    fetchTables(): Promise<ApiCmsTable[]>;
+    private useDraftForTable;
+    query(table: string, params?: QueryParams): Promise<ApiCmsRow[]>;
+    count(table: string, params?: Pick<QueryParams, "where" | "useDraft">): Promise<number>;
+}
+
+declare interface ApiCmsRow {
+    identifier: string | null;
+    data: Record<string, any> | null;
+}
+
+declare interface ApiCmsTable {
+    identifier: string;
+    name: string;
+    schema: CmsTableSchema;
+}
+
+declare interface CmsBaseType {
+    identifier: string;
+    name: string;
+    helperText: string;
+    required: boolean;
+    hidden: boolean;
+}
+
+declare interface CmsBoolean extends CmsBaseType {
+    type: CmsMetaType.BOOLEAN;
+    defaultValue?: boolean;
+}
+
+export declare function CmsCount({ className, table, setControlContextData, ...rest }: CmsCountProps): React_2.JSX.Element | null;
+
+export declare const cmsCountFieldMeta: ComponentMeta<CmsCountProps>;
+
+declare interface CmsCountProps extends CanvasComponentProps<RowContextData> {
+    table: string;
+    className?: string;
+}
+
+export declare function CmsCredentialsProvider({ children, databaseId, databaseToken, host, locale, useDraft, }: CmsCredentialsProviderProps): React_2.JSX.Element;
+
+export declare const cmsCredentialsProviderMeta: GlobalContextMeta<CmsCredentialsProviderProps>;
+
+declare interface CmsCredentialsProviderProps extends DatabaseConfig {
+    children?: React_2.ReactNode;
+}
+
+declare interface CmsDateTime extends CmsBaseType {
+    type: CmsMetaType.DATE_TIME;
+    defaultValue?: string;
+}
+
+declare interface CmsEnum extends CmsBaseType {
+    type: CmsMetaType.ENUM;
+    defaultValue?: string;
+    options: string[];
+}
+
+declare type CmsFieldMeta = CmsText | CmsLongText | CmsNumber | CmsBoolean | CmsImage | CmsFile | CmsDateTime | CmsRef | CmsRichText | CmsEnum;
+
+declare interface CmsFile extends CmsBaseType {
+    type: CmsMetaType.FILE;
+    defaultValue?: string;
+}
+
+declare interface CmsImage extends CmsBaseType {
+    type: CmsMetaType.IMAGE;
+    defaultValue?: string;
+}
+
+declare interface CmsLongText extends CmsBaseType, CmsTextLike {
+    type: CmsMetaType.LONG_TEXT;
+}
+
+declare const enum CmsMetaType {
+    TEXT = "text",
+    LONG_TEXT = "long-text",
+    NUMBER = "number",
+    IMAGE = "image",
+    FILE = "file",
+    DATE_TIME = "date-time",
+    BOOLEAN = "boolean",
+    COLOR = "color",
+    RICH_TEXT = "rich-text",
+    REF = "ref",
+    LIST = "list",
+    OBJECT = "object",
+    ENUM = "enum"
+}
+
+declare interface CmsNumber extends CmsBaseType {
+    type: CmsMetaType.NUMBER;
+    defaultValue?: number;
+}
+
+export declare function CmsQueryRepeater({ table, children, setControlContextData, mode, where, useDraft, orderBy, desc, limit, offset, emptyMessage, forceEmptyState, loadingMessage, forceLoadingState, noLayout, noAutoRepeat, className, filterField, filterValue, fields, }: CmsQueryRepeaterProps): React_2.JSX.Element;
+
+export declare const cmsQueryRepeaterMeta: ComponentMeta<CmsQueryRepeaterProps>;
+
+declare interface CmsQueryRepeaterProps extends QueryParams, CanvasComponentProps<TableContextData> {
+    children: React_2.ReactNode;
+    table: string;
+    emptyMessage?: React_2.ReactNode;
+    forceEmptyState?: boolean;
+    loadingMessage?: React_2.ReactNode;
+    forceLoadingState?: boolean;
+    noLayout?: boolean;
+    noAutoRepeat?: boolean;
+    className?: string;
+    filterField?: string;
+    filterValue?: string;
+    fields?: string[];
+    mode?: "rows" | "count";
+}
+
+declare interface CmsRef extends CmsBaseType {
+    type: CmsMetaType.REF;
+    defaultValue?: string;
+}
+
+declare interface CmsRichText extends CmsBaseType {
+    type: CmsMetaType.RICH_TEXT;
+    defaultValue?: string;
+}
+
+export declare function CmsRowField({ className, table, field, dateFormat, setControlContextData, usePlasmicTheme, themeResetClassName, ...rest }: CmsRowFieldProps): React_2.JSX.Element | null;
+
+export declare const cmsRowFieldMeta: ComponentMeta<CmsRowFieldProps>;
+
+declare interface CmsRowFieldProps extends CanvasComponentProps<RowContextData> {
+    table: string;
+    field: string;
+    className?: string;
+    dateFormat?: string;
+    usePlasmicTheme?: boolean;
+    themeResetClassName?: string;
+}
+
+export declare function CmsRowFieldValue({ table, field, valueProp, children, setControlContextData, ...rest }: CmsRowFieldValueProps): React_2.ReactElement | null;
+
+export declare const cmsRowFieldValueMeta: ComponentMeta<CmsRowFieldValueProps>;
+
+declare interface CmsRowFieldValueProps extends CanvasComponentProps<RowContextData> {
+    table: string;
+    field: string;
+    valueProp: string;
+    children: React_2.ReactNode;
+}
+
+export declare function CmsRowImage({ table, field, srcProp, children, setControlContextData, }: CmsRowImageProps): React_2.ReactElement | null;
+
+export declare const cmsRowImageMeta: ComponentMeta<CmsRowImageProps>;
+
+declare interface CmsRowImageProps extends CanvasComponentProps<RowContextData> {
+    table: string;
+    field: string;
+    srcProp: string;
+    children: React_2.ReactNode;
+}
+
+export declare function CmsRowLink({ table, field, hrefProp, children, setControlContextData, prefix, suffix, }: CmsRowLinkProps): React_2.ReactElement | null;
+
+export declare const cmsRowLinkMeta: ComponentMeta<CmsRowLinkProps>;
+
+declare interface CmsRowLinkProps extends CanvasComponentProps<RowContextData> {
+    table: string;
+    field: string;
+    hrefProp: string;
+    children: React_2.ReactNode;
+    prefix?: string;
+    suffix?: string;
+}
+
+declare interface CmsTableSchema {
+    fields: CmsFieldMeta[];
+}
+
+declare interface CmsText extends CmsBaseType, CmsTextLike {
+    type: CmsMetaType.TEXT;
+}
+
+declare interface CmsTextLike {
+    defaultValue?: string;
+    minChars?: number;
+    maxChars?: number;
+}
+
+export declare interface DatabaseConfig {
+    host: string;
+    databaseId: string;
+    databaseToken: string;
+    locale?: string;
+    useDraft?: boolean | string[];
+}
+
+export declare function fetchContent(cmsId: string, cmsPublicToken: string, tableId: string, params: QueryParams, useDraft: boolean, locale: string): Promise<ApiCmsRow_2[]>;
+
+export declare function fetchCount(cmsId: string, cmsPublicToken: string, tableId: string, params: QueryParams, useDraft: boolean): Promise<number>;
+
+export declare function fetchTables(cmsId: string, cmsPublicToken: string): Promise<ApiCmsTable_2[]>;
+
+export declare class HttpError extends Error {
+    status: number;
+    constructor(status: number, message: string);
+}
+
+export declare function mkApi(config: DatabaseConfig | undefined): API;
+
+export declare interface QueryParams {
+    useDraft?: boolean;
+    where?: any;
+    orderBy?: string;
+    desc?: boolean;
+    limit?: number;
+    offset?: number;
+    fields?: string[];
+}
+
+export declare function registerAll(loader?: {
+    registerComponent: typeof registerComponent;
+    registerGlobalContext: typeof registerGlobalContext;
+}): void;
+
+export declare function registerAllCustomFunctions(loader?: {
+    registerFunction: any;
+}): void;
+
+declare interface RowContextData extends TableContextData {
+    row?: ApiCmsRow;
+    fieldMeta?: CmsFieldMeta;
+}
+
+declare interface TableContextData extends TablesContextData {
+    table?: string;
+}
+
+declare type TablesContextData = {
+    tables?: ApiCmsTable[];
+};
+
+export { }