@blokkli/editor 1.4.0-alpha.0 → 1.4.0-alpha.1

package/dist/module.d.mts

@@ -1,8 +1,8 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { FeatureDefinition, BlockDefinitionOptionsInput } from '../dist/runtime/types/index.js';
+import { FeatureDefinition, BlockDefinitionInput, BlockDefinitionOptionsInput } from '../dist/runtime/types/index.js';
 import { AdapterMethods } from '../dist/runtime/adapter/index.js';
 import { ThemeName, Theme } from '../dist/runtime/types/theme.js';
-import { ModuleOptionsSettings } from '#blokkli/types/generatedModuleTypes';
+import { ModuleOptionsSettings } from '../dist/runtime/types/generatedModuleTypes.js';
 
 type ExtractedFeatureDefinition = {
     id: string;
@@ -13,6 +13,25 @@ type ExtractedFeatureDefinition = {
     source: string;
 };
 
+type ExtractedBlockDefinitionInput = BlockDefinitionInput;
+type ExtractedDefinition = {
+    filePath: string;
+    icon?: string;
+    chunkName: string;
+    componentName: string;
+    proxyComponent?: string;
+    diffComponent?: string;
+    definition: ExtractedBlockDefinitionInput;
+    source: string;
+    fileSource: string;
+    hasBlokkliField: boolean;
+};
+type GetBundlePropsTypeResult = {
+    typeName: string;
+    from: string;
+};
+type GetBundlePropsType = (name: string, definition: ExtractedDefinition) => GetBundlePropsTypeResult;
+
 type AlterFeatures = {
     features: ExtractedFeatureDefinition[];
 };
@@ -123,6 +142,56 @@ type ModuleOptions = {
      * bundles.
      */
     storageDefaults?: ModuleOptionsStorageDefaults;
+    /**
+     * Method that is called for each block bundle component to generate the
+     * prop types.
+     *
+     * These types are used if you access a block item with the generated
+     * FieldListItemTyped type, for example through:
+     * const { rootBlocks } = defineBlokkli().
+     *
+     * or using <BlokkliField v-slot="{ items }">.
+     *
+     * The method receives the name of the bundle and the extracted block
+     * definition as the second argument.
+     * The return value should be an object with these properties:
+     *
+     * - typeName: The name of the type
+     * - from: Where the type can be imported from
+     *
+     * For example, if the method returns this object:
+     * ```typescript
+     * {
+     *   typeName: 'ParagraphTextWithImageFragment',
+     *   from: '#graphql-operations'
+     * }
+     * ```
+     *
+     * Then the module will generate this TypeScript code:
+     *
+     * ```typescript
+     * import type { ParagraphTextWithImageFragment } from '#graphql-operations'
+     * ```
+     *
+     * And assign the imported type as the type for the `props` property for this bundle.
+     *
+     * Then, for example in a block component:
+     *
+     * ```typescript
+     * const { siblings, index } = defineBlokkli()
+     *
+     * const previousBlock = computed(() => siblings.value[index.value - 1])
+     *
+     * const previousTitle = computed(() => {
+     *   // The previous block in the list is a title.
+     *   if (previousBlock.value?.bundle === 'title') {
+     *     // The type of the props are now typed correctly.
+     *     const title = previousBlock.value.props.title
+     *   }
+     * })
+     * ```
+     */
+    getBundlePropsType?: GetBundlePropsType;
 };
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 

package/dist/module.d.ts

@@ -1,8 +1,8 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { FeatureDefinition, BlockDefinitionOptionsInput } from '../dist/runtime/types/index.js';
+import { FeatureDefinition, BlockDefinitionInput, BlockDefinitionOptionsInput } from '../dist/runtime/types/index.js';
 import { AdapterMethods } from '../dist/runtime/adapter/index.js';
 import { ThemeName, Theme } from '../dist/runtime/types/theme.js';
-import { ModuleOptionsSettings } from '#blokkli/types/generatedModuleTypes';
+import { ModuleOptionsSettings } from '../dist/runtime/types/generatedModuleTypes.js';
 
 type ExtractedFeatureDefinition = {
     id: string;
@@ -13,6 +13,25 @@ type ExtractedFeatureDefinition = {
     source: string;
 };
 
+type ExtractedBlockDefinitionInput = BlockDefinitionInput;
+type ExtractedDefinition = {
+    filePath: string;
+    icon?: string;
+    chunkName: string;
+    componentName: string;
+    proxyComponent?: string;
+    diffComponent?: string;
+    definition: ExtractedBlockDefinitionInput;
+    source: string;
+    fileSource: string;
+    hasBlokkliField: boolean;
+};
+type GetBundlePropsTypeResult = {
+    typeName: string;
+    from: string;
+};
+type GetBundlePropsType = (name: string, definition: ExtractedDefinition) => GetBundlePropsTypeResult;
+
 type AlterFeatures = {
     features: ExtractedFeatureDefinition[];
 };
@@ -123,6 +142,56 @@ type ModuleOptions = {
      * bundles.
      */
     storageDefaults?: ModuleOptionsStorageDefaults;
+    /**
+     * Method that is called for each block bundle component to generate the
+     * prop types.
+     *
+     * These types are used if you access a block item with the generated
+     * FieldListItemTyped type, for example through:
+     * const { rootBlocks } = defineBlokkli().
+     *
+     * or using <BlokkliField v-slot="{ items }">.
+     *
+     * The method receives the name of the bundle and the extracted block
+     * definition as the second argument.
+     * The return value should be an object with these properties:
+     *
+     * - typeName: The name of the type
+     * - from: Where the type can be imported from
+     *
+     * For example, if the method returns this object:
+     * ```typescript
+     * {
+     *   typeName: 'ParagraphTextWithImageFragment',
+     *   from: '#graphql-operations'
+     * }
+     * ```
+     *
+     * Then the module will generate this TypeScript code:
+     *
+     * ```typescript
+     * import type { ParagraphTextWithImageFragment } from '#graphql-operations'
+     * ```
+     *
+     * And assign the imported type as the type for the `props` property for this bundle.
+     *
+     * Then, for example in a block component:
+     *
+     * ```typescript
+     * const { siblings, index } = defineBlokkli()
+     *
+     * const previousBlock = computed(() => siblings.value[index.value - 1])
+     *
+     * const previousTitle = computed(() => {
+     *   // The previous block in the list is a title.
+     *   if (previousBlock.value?.bundle === 'title') {
+     *     // The type of the props are now typed correctly.
+     *     const title = previousBlock.value.props.title
+     *   }
+     * })
+     * ```
+     */
+    getBundlePropsType?: GetBundlePropsType;
 };
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "blokkli",
   "configKey": "blokkli",
-  "version": "1.4.0-alpha.0",
+  "version": "1.4.0-alpha.1",
   "compatibility": {
     "nuxt": "^3.12.0"
   },