@diagonal-hq/cli 0.0.0-stage → 0.2.0

package/dist/fields.generated.d.ts

@@ -0,0 +1,416 @@
+// Generated by `artisan app:generate-custom-typescript` from VariableType. Do not edit.
+// The field builders of defineResource, one for each resource field type, and the data API endpoints.
+
+import type { StaticValue } from './index';
+
+export type FieldType = "boolean" | "color" | "content" | "date" | "datetime" | "dictionary" | "email" | "event_schedule" | "file_reference" | "liquid" | "list" | "location" | "markdown" | "money" | "number" | "password" | "phone" | "recurrence" | "regular_hours" | "relation" | "resource_reference" | "select" | "text" | "time" | "timezone" | "url" | "uuid" | "wallet_accounting_account" | "wallet_accounting_entity";
+
+/** A switch of `dataApi.endpoints` in defineResource. */
+export type DataApiEndpoint = "analytics_distribution" | "analytics_kpi" | "analytics_leaderboard" | "analytics_time_series" | "count" | "create" | "create_many" | "create_many_from_file" | "delete" | "delete_many" | "export" | "index" | "restore" | "search" | "show" | "update" | "update_many" | "upsert" | "upsert_many";
+
+/** A declarative resolver tree, for example `{ $type: 'text.slugify', $value: { ... } }`. */
+export type Resolver = { readonly $type: string; readonly $value?: StaticValue };
+
+/** One nested field of a list or dictionary schema. */
+export type FieldSchemaDefinition = {
+  key: string;
+  type: FieldType;
+  label?: string;
+  description?: string | null;
+  guard?: readonly string[];
+  value?: StaticValue;
+  settings?: { readonly schema?: FieldSchemaSetting; readonly [setting: string]: StaticValue | FieldSchemaSetting | undefined };
+};
+
+/** A dictionary schema lists its keys. A list schema is one item definition, or a tuple of definitions. */
+export type FieldSchemaSetting = FieldSchemaDefinition | readonly FieldSchemaDefinition[];
+
+export type CommonFieldSettings = {
+  "seed_type"?: string | null;
+  "faker_method"?: string | null;
+  "faker_parameters"?: readonly StaticValue[] | null;
+  "seed_data"?: readonly StaticValue[] | null;
+};
+
+export type FieldDefinition<TType extends FieldType = FieldType> = {
+  readonly $field: TType;
+};
+
+type BaseFieldOptions<TSettings> = {
+  label?: string;
+  description?: string | null;
+  /** Adds the `required` guard. Without it the field is nullable. */
+  required?: boolean;
+  /** Further validation rules, for example `['max:255']`. */
+  guard?: readonly string[];
+  /** The value of a new record. It does not backfill records. */
+  default?: StaticValue;
+  /** Writes `settings.unique` and a unique index. */
+  unique?: boolean;
+  /** Adds a non-unique single-field index. */
+  index?: boolean;
+  /** A read-time resolver. The field becomes virtual: it is not stored, indexed, or writable. */
+  computed?: Resolver;
+  /** Transforms the stored value when it is read. */
+  getter?: Resolver;
+  /** Computes the stored value before each create and update. */
+  setter?: Resolver;
+  /** Runs the setter only when the value is null or an empty string. */
+  setterWhenEmpty?: boolean;
+  settings?: TSettings;
+};
+
+export type BooleanFieldSettings = CommonFieldSettings & {
+  "yes_label"?: string | null;
+  "no_label"?: string | null;
+  ui?: {
+    field_type?: "boolean" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type ColorFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "color" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type ContentFieldSettings = CommonFieldSettings & {
+  "multi_line"?: boolean | null;
+  "extensions"?: {
+    "bold"?: boolean | null;
+    "italic"?: boolean | null;
+    "strike"?: boolean | null;
+    "underline"?: boolean | null;
+    "link"?: boolean | null;
+  };
+  "allowed_nodes"?: {
+    "heading"?: boolean | null;
+    "blockquote"?: boolean | null;
+    "bulletList"?: boolean | null;
+    "orderedList"?: boolean | null;
+    "media"?: boolean | null;
+  };
+  "placeholder"?: string | null;
+  ui?: {
+    field_type?: "content" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type DateFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "date" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+    "display_format"?: "MMMM d, yyyy" | "MMM d, yyyy" | "MM/dd/yyyy" | "yyyy-MM-dd" | null;
+  };
+};
+
+export type DatetimeFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "datetime" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+    "display_format"?: "MMMM d, yyyy h:mm a" | "MMM d, yyyy h:mm a" | "MM/dd/yyyy h:mm a" | "yyyy-MM-dd'T'HH:mm:ss" | null;
+  };
+};
+
+export type DictionaryFieldSettings = CommonFieldSettings & {
+  "schema": FieldSchemaSetting;
+  ui?: {
+    field_type?: "dictionary" | "json" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type EmailFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "text" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type EventScheduleFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "event_schedule" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type FileReferenceFieldSettings = CommonFieldSettings & {
+  "accept"?: unknown[] | null;
+  "visibility"?: "private" | "public" | null;
+  ui?: {
+    field_type?: "file" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type LiquidFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "code" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type ListFieldSettings = CommonFieldSettings & {
+  "schema": FieldSchemaSetting;
+  ui?: {
+    field_type?: "list" | "combobox" | "resource_field" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type LocationFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "location" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+    "display_format"?: "formatted_address" | "map" | null;
+  };
+};
+
+export type MarkdownFieldSettings = CommonFieldSettings & {
+  "allowed_marks"?: Array<string> | null;
+  "allowed_blocks"?: Array<string> | null;
+  ui?: {
+    field_type?: "markdown" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+    "show_formatting_toolbar"?: boolean | null;
+    "toolbar_placement"?: "floating" | "fixed" | null;
+  };
+};
+
+export type MoneyFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "money" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type NumberFieldSettings = CommonFieldSettings & {
+  "integer"?: boolean | null;
+  "minimum"?: number | null;
+  "maximum"?: number | null;
+  ui?: {
+    field_type?: "number" | "rating" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type PasswordFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "password" | "text" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type PhoneFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "phone" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type RecurrenceFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "recurrence" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type RegularHoursFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "regular_hours" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type RelationFieldSettings = CommonFieldSettings & {
+  "filters"?: Record<string, unknown> | null;
+  "delete_policy"?: "cascade" | "ignore" | "restrict" | "set_null" | null;
+  /** The relation field that the build adds to the target resource. */
+  inverse?: RelationInverse | null;
+  ui?: {
+    field_type?: "relation" | null;
+    "allow_inline_create_on_creating"?: boolean | null;
+    "allow_inline_attach_on_creating"?: boolean | null;
+    "allow_inline_create_on_updating"?: boolean | null;
+    "allow_inline_attach_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type ResourceReferenceFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "resource" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type SelectFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "select" | "inline_select" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type TextFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "text" | "textarea" | "code" | "icon" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type TimeFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "time" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+    "display_format"?: "h:mm a" | "HH:mm" | null;
+  };
+};
+
+export type TimezoneFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "timezone" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type UrlFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "url" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type UuidFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "text" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type WalletAccountingAccountFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "wallet_accounting_account" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+export type WalletAccountingEntityFieldSettings = CommonFieldSettings & {
+  ui?: {
+    field_type?: "wallet_accounting_entity" | null;
+    "show_on_creating"?: boolean | null;
+    "show_on_updating"?: boolean | null;
+    "placeholder"?: string | null;
+  };
+};
+
+/**
+ * The inverse of a relation. It points back at the resource that declares it,
+ * and its relation type is the inverse of the declaring relation type.
+ */
+export type RelationInverse = {
+  key: string;
+  label?: string;
+  description?: string | null;
+  settings?: Omit<RelationFieldSettings, 'inverse'> & { "max_connections"?: number | null };
+};
+
+/** A relation names its target resource by id or slug. The type defaults to `belongs_to`. */
+export type RelationFieldOptions = Omit<BaseFieldOptions<RelationFieldSettings>, 'settings'> & { resource: string } & (
+  | { type?: "belongs_to"; settings?: RelationFieldSettings }
+  | { type: "belongs_to_many"; settings?: RelationFieldSettings & { "max_connections"?: number | null } }
+  | { type: "has_many"; settings?: RelationFieldSettings & { "max_connections"?: number | null } }
+  | { type: "has_one"; settings?: RelationFieldSettings }
+);
+
+export declare const field: {
+  boolean(options?: BaseFieldOptions<BooleanFieldSettings>): FieldDefinition<"boolean">;
+  color(options?: BaseFieldOptions<ColorFieldSettings>): FieldDefinition<"color">;
+  content(options?: BaseFieldOptions<ContentFieldSettings>): FieldDefinition<"content">;
+  date(options?: BaseFieldOptions<DateFieldSettings>): FieldDefinition<"date">;
+  datetime(options?: BaseFieldOptions<DatetimeFieldSettings>): FieldDefinition<"datetime">;
+  dictionary(options: Omit<BaseFieldOptions<DictionaryFieldSettings>, 'settings'> & { settings: DictionaryFieldSettings }): FieldDefinition<"dictionary">;
+  email(options?: BaseFieldOptions<EmailFieldSettings>): FieldDefinition<"email">;
+  eventSchedule(options?: BaseFieldOptions<EventScheduleFieldSettings>): FieldDefinition<"event_schedule">;
+  /** Stored as a `file_reference` field. */
+  file(options?: BaseFieldOptions<FileReferenceFieldSettings>): FieldDefinition<"file_reference">;
+  fileReference(options?: BaseFieldOptions<FileReferenceFieldSettings>): FieldDefinition<"file_reference">;
+  liquid(options?: BaseFieldOptions<LiquidFieldSettings>): FieldDefinition<"liquid">;
+  list(options: Omit<BaseFieldOptions<ListFieldSettings>, 'settings'> & { settings: ListFieldSettings }): FieldDefinition<"list">;
+  location(options?: BaseFieldOptions<LocationFieldSettings>): FieldDefinition<"location">;
+  /** Stored as a `text` field. */
+  longText(options?: BaseFieldOptions<TextFieldSettings>): FieldDefinition<"text">;
+  markdown(options?: BaseFieldOptions<MarkdownFieldSettings>): FieldDefinition<"markdown">;
+  money(options?: BaseFieldOptions<MoneyFieldSettings>): FieldDefinition<"money">;
+  number(options?: BaseFieldOptions<NumberFieldSettings>): FieldDefinition<"number">;
+  password(options?: BaseFieldOptions<PasswordFieldSettings>): FieldDefinition<"password">;
+  phone(options?: BaseFieldOptions<PhoneFieldSettings>): FieldDefinition<"phone">;
+  recurrence(options?: BaseFieldOptions<RecurrenceFieldSettings>): FieldDefinition<"recurrence">;
+  regularHours(options?: BaseFieldOptions<RegularHoursFieldSettings>): FieldDefinition<"regular_hours">;
+  relation(options: RelationFieldOptions): FieldDefinition<"relation">;
+  resourceReference(options?: BaseFieldOptions<ResourceReferenceFieldSettings>): FieldDefinition<"resource_reference">;
+  select(options: BaseFieldOptions<SelectFieldSettings> & { options: readonly { label: string; value: string; color?: string | null }[] }): FieldDefinition<"select">;
+  text(options?: BaseFieldOptions<TextFieldSettings>): FieldDefinition<"text">;
+  time(options?: BaseFieldOptions<TimeFieldSettings>): FieldDefinition<"time">;
+  timezone(options?: BaseFieldOptions<TimezoneFieldSettings>): FieldDefinition<"timezone">;
+  url(options?: BaseFieldOptions<UrlFieldSettings>): FieldDefinition<"url">;
+  uuid(options?: BaseFieldOptions<UuidFieldSettings>): FieldDefinition<"uuid">;
+  walletAccountingAccount(options?: BaseFieldOptions<WalletAccountingAccountFieldSettings>): FieldDefinition<"wallet_accounting_account">;
+  walletAccountingEntity(options?: BaseFieldOptions<WalletAccountingEntityFieldSettings>): FieldDefinition<"wallet_accounting_entity">;
+};

package/dist/fields.generated.js

@@ -0,0 +1,35 @@
+// Generated by `artisan app:generate-custom-typescript` from VariableType. Do not edit.
+
+export const field = {
+  boolean: (options = {}) => ({ $field: "boolean", ...options }),
+  color: (options = {}) => ({ $field: "color", ...options }),
+  content: (options = {}) => ({ $field: "content", ...options }),
+  date: (options = {}) => ({ $field: "date", ...options }),
+  datetime: (options = {}) => ({ $field: "datetime", ...options }),
+  dictionary: (options = {}) => ({ $field: "dictionary", ...options }),
+  email: (options = {}) => ({ $field: "email", ...options }),
+  eventSchedule: (options = {}) => ({ $field: "event_schedule", ...options }),
+  file: (options = {}) => ({ $field: "file_reference", ...options }),
+  fileReference: (options = {}) => ({ $field: "file_reference", ...options }),
+  liquid: (options = {}) => ({ $field: "liquid", ...options }),
+  list: (options = {}) => ({ $field: "list", ...options }),
+  location: (options = {}) => ({ $field: "location", ...options }),
+  longText: (options = {}) => ({ $field: "text", ...options }),
+  markdown: (options = {}) => ({ $field: "markdown", ...options }),
+  money: (options = {}) => ({ $field: "money", ...options }),
+  number: (options = {}) => ({ $field: "number", ...options }),
+  password: (options = {}) => ({ $field: "password", ...options }),
+  phone: (options = {}) => ({ $field: "phone", ...options }),
+  recurrence: (options = {}) => ({ $field: "recurrence", ...options }),
+  regularHours: (options = {}) => ({ $field: "regular_hours", ...options }),
+  relation: (options = {}) => ({ $field: "relation", ...options }),
+  resourceReference: (options = {}) => ({ $field: "resource_reference", ...options }),
+  select: (options = {}) => ({ $field: "select", ...options }),
+  text: (options = {}) => ({ $field: "text", ...options }),
+  time: (options = {}) => ({ $field: "time", ...options }),
+  timezone: (options = {}) => ({ $field: "timezone", ...options }),
+  url: (options = {}) => ({ $field: "url", ...options }),
+  uuid: (options = {}) => ({ $field: "uuid", ...options }),
+  walletAccountingAccount: (options = {}) => ({ $field: "wallet_accounting_account", ...options }),
+  walletAccountingEntity: (options = {}) => ({ $field: "wallet_accounting_entity", ...options }),
+};

package/dist/globals.d.ts

@@ -0,0 +1,72 @@
+// The `Sdk` and `React` globals of page, layout, component, and email files.
+// The same types that the deploy type check uses.
+/// <reference path="./sdk-contract.d.ts" />
+declare namespace React {
+  type ReactNode = RenderableChild;
+  type ReactElement = any;
+  type ComponentType<P = any> = (props: P) => any;
+  type FC<P = any> = (props: P & { children?: RenderableChild }) => any;
+  type PropsWithChildren<P = unknown> = P & { children?: RenderableChild };
+  type CSSProperties = { [property: string]: any };
+  type RefObject<T = any> = { current: T };
+  type MutableRefObject<T = any> = { current: T };
+  type Ref<T = any> = ((instance: T | null) => void) | RefObject<T | null> | null;
+  type Dispatch<A = any> = (value: A) => void;
+  type SetStateAction<S = any> = S | ((previousState: S) => S);
+  type DependencyList = readonly unknown[];
+  type ChangeEvent<T = any> = any;
+  type FormEvent<T = any> = any;
+  type MouseEvent<T = any> = any;
+  type KeyboardEvent<T = any> = any;
+  type FocusEvent<T = any> = any;
+}
+interface DiagonalReactGlobal {
+  useState(initialState: null): [any, React.Dispatch<React.SetStateAction<any>>];
+  useState(initialState: never[]): [any[], React.Dispatch<React.SetStateAction<any[]>>];
+  useState<S>(initialState: S | (() => S)): [S, React.Dispatch<React.SetStateAction<S>>];
+  useState<S = undefined>(): [S | undefined, React.Dispatch<React.SetStateAction<S | undefined>>];
+  useEffect(effect: () => any, deps?: React.DependencyList): void;
+  useLayoutEffect(effect: () => any, deps?: React.DependencyList): void;
+  useMemo<T>(factory: () => T, deps?: React.DependencyList): T;
+  useCallback<T extends (...args: any[]) => any>(callback: T, deps?: React.DependencyList): T;
+  useRef<T>(initialValue: T): React.RefObject<T>;
+  useRef<T>(initialValue: T | null): React.RefObject<T | null>;
+  useRef<T>(initialValue: T | undefined): React.RefObject<T | undefined>;
+  useReducer<S, A>(reducer: (state: S, action: A) => S, initialState: S): [S, React.Dispatch<A>];
+  useReducer<S, A, I>(
+    reducer: (state: S, action: A) => S,
+    initializerArg: I,
+    initializer: (arg: I) => S
+  ): [S, React.Dispatch<A>];
+  useContext<T = any>(context: unknown): T;
+  useId(): string;
+  useTransition(): [boolean, (callback: () => void) => void];
+  useDeferredValue<T>(value: T): T;
+  memo<T>(component: T, arePropsEqual?: (previous: any, next: any) => boolean): T;
+  forwardRef<T = any, P = any>(
+    render: (props: P, ref: React.Ref<T>) => any
+  ): (props: P & { ref?: React.Ref<T> }) => any;
+  [member: string]: any;
+}
+declare const React: DiagonalReactGlobal;
+declare namespace JSX {
+  type Element = any;
+  interface ElementChildrenAttribute { children: {}; }
+  interface IntrinsicAttributes { key?: any; }
+  interface IntrinsicElements { [name: string]: { [attribute: string]: any; children?: RenderableChild }; }
+}
+type RenderableChild =
+  | string
+  | number
+  | bigint
+  | boolean
+  | null
+  | undefined
+  | Iterable<RenderableChild>
+  | Promise<RenderableChild>;
+
+// The editor does not know the workspace components, so any Sdk.Custom name is allowed.
+declare module "diagonal:sdk-internal" {
+interface CustomComponentRegistry { [key: string]: SdkComponent }
+}
+