@antlur/backstage 1.0.10 → 1.2.0

package/src/studio/define-block.ts

@@ -0,0 +1,14 @@
+import { BlockSchema, BlockDefinition, BlockComponentProps, Field } from "./types";
+
+export type FieldValues<TFields extends Record<string, Field<any>>> = {
+  [K in keyof TFields]: TFields[K]["value"];
+};
+
+export function defineBlock<TFields extends Record<string, Field<any>>>(options: {
+  name: string;
+  slug: string;
+  schema: BlockSchema<TFields>;
+  component: React.ComponentType<BlockComponentProps<FieldValues<TFields>>>; // Correct typing here
+}): BlockDefinition<TFields> {
+  return options;
+}

package/src/studio/define-field.ts

@@ -0,0 +1,5 @@
+import { Field } from "./types";
+
+export function defineField<TValue>(field: Field<TValue>): Field<TValue> {
+  return field;
+}

package/src/studio/define-schema.ts

@@ -0,0 +1,5 @@
+import { BlockSchema, Field } from "./types";
+
+export function defineSchema<TFields extends Record<string, Field<any>>>(schema: BlockSchema<TFields>) {
+  return schema;
+}

package/src/studio/index.ts

@@ -0,0 +1,5 @@
+export * from "./types";
+
+export * from "./define-block";
+export * from "./define-field";
+export * from "./define-schema";

package/src/studio/types/block.ts

@@ -0,0 +1,29 @@
+import { FieldValues } from "../define-block";
+import { Field } from "./field";
+
+export interface BlockSchema<TFields extends Record<string, Field<any>>> {
+  fields: TFields;
+  properties?: BlockProperties;
+}
+
+export interface BlockDefinition<TFields extends Record<string, Field<any>>> {
+  name: string;
+  schema: BlockSchema<TFields>;
+  component: React.ComponentType<BlockComponentProps<FieldValues<TFields>>>;
+}
+
+export interface BuilderBlock<TFields extends Record<string, Field<any>>> {
+  id: string;
+  type: string;
+  fields: TFields;
+  properties?: BlockProperties;
+}
+
+export interface BlockProperties {
+  customClassName?: string;
+}
+
+export interface BlockComponentProps<TFieldValues extends Record<string, any>> {
+  block: BuilderBlock<TFieldValues>;
+  onFieldChange: (blockId: string, fieldName: keyof TFieldValues, value: any) => void;
+}

package/src/studio/types/field-values.ts

@@ -0,0 +1,7 @@
+export interface Media {
+  id: string;
+  url: string;
+  width: number;
+  height: number;
+  alt: string;
+}

package/src/studio/types/field.ts

@@ -0,0 +1,28 @@
+export type FieldType =
+  | "boolean"
+  | "event_select"
+  | "form_select"
+  | "image"
+  | "image_list"
+  | "list_array"
+  | "media"
+  | "menu_select"
+  | "number"
+  | "press_select"
+  | "repeater"
+  | "rich_text"
+  | "separator"
+  | "spacer"
+  | "text"
+  | "textarea"
+  | "url";
+
+export interface Field<TValue = any> {
+  name: string;
+  slug: string;
+  type: FieldType;
+  value?: TValue;
+  placeholder?: string;
+  required?: boolean;
+  options?: Array<{ label: string; value: any }>;
+}

package/src/studio/types/index.ts

@@ -0,0 +1,4 @@
+export * from "./block";
+export * from "./field";
+
+export * from "./field-values";

package/src/types/index.ts

@@ -11,3 +11,5 @@ export * from "./navigation";
 export * from "./page";
 export * from "./press";
 export * from "./website";
+
+export * from "../studio/types/index";