@blokkli/editor 1.4.0-alpha.1 → 2.0.0-alpha.2

package/dist/module.d.mts

@@ -1,198 +1,16 @@
 import * as _nuxt_schema from '@nuxt/schema';
-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 '../dist/runtime/types/generatedModuleTypes.js';
+import { M as ModuleHooks, a as ModuleOptions } from './shared/editor.gz_ac6uT.mjs';
+import 'nuxt/schema';
+import '../dist/runtime/types/index.js';
+import '#blokkli-build/module-types';
+import '../dist/runtime/types/theme.js';
+import '@nuxt/kit';
 
-type ExtractedFeatureDefinition = {
-    id: string;
-    componentName: string;
-    componentPath: string;
-    filePath: string;
-    definition: FeatureDefinition<AdapterMethods[]>;
-    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[];
-};
-type ModuleOptionsStorageDefaults = {
-    /**
-     * The default favorite block bundles.
-     */
-    blockFavorites?: string[];
-};
-/**
- * Options for the module.
- */
-type ModuleOptions = {
-    /**
-     * The pattern of source files to scan for blokkli components.
-     */
-    pattern?: string[];
-    /**
-     * Define reusable options that can be used in blokkli item components by
-     * referencing the option name.
-     */
-    globalOptions?: BlockDefinitionOptionsInput;
-    /**
-     * Define available chunk groups.
-     *
-     * The idea of this feature is to split rarely used components into separate
-     * chunks, so that they are not imported on each page.
-     *
-     * This value should only be set if the component is actually used rarely.
-     * Having too many chunks has the opposite effect, as rendering a page
-     * requires multiple requests.
-     *
-     * If left empty, all components are bundled in a default chunk, which should
-     * contain components that are used for most pages.
-     */
-    chunkNames?: string[];
-    /**
-     * Valid field list types.
-     *
-     * If one or more values are defined, they can be passed to the BlokkliField
-     * component as a prop. The value is made available to all blokkli items inside
-     * this field.
-     */
-    fieldListTypes?: string[];
-    /**
-     * The entity type of blokkli items.
-     *
-     * Using the paragraphs_blokkli integration this value should be set to "paragraph".
-     */
-    itemEntityType?: string;
-    /**
-     * Provide overrides for the translations.
-     */
-    translations?: Record<string, Record<string, string>>;
-    /**
-     * The default/fallback language for the editor.
-     */
-    defaultLanguage?: string;
-    /**
-     * Force the editor to always be in the default language.
-     *
-     * The default behaviour is that the editor is rendered in the same language
-     * as the page entity. Setting this value to true will always render the
-     * editor in the default language.
-     */
-    forceDefaultLanguage?: boolean;
-    /**
-     * Alter features.
-     *
-     * It's also possible to override builtin feature components with custom
-     * implementations.
-     */
-    alterFeatures?: (ctx: AlterFeatures) => Promise<ExtractedFeatureDefinition[]> | ExtractedFeatureDefinition[];
-    /**
-     * Add custom features by defining either a pattern or path to a feature component.
-     */
-    featureImports?: string[];
-    /**
-     * Theme colors for the editor.
-     *
-     * Accent colors are used for selections, highlights, buttons.
-     * Mono colors are used for the UI elements in the editor.
-     */
-    theme?: ThemeName | Partial<Theme>;
-    /**
-     * Enable the theme editor feature.
-     */
-    enableThemeEditor?: boolean;
-    /**
-     * blokkli generates a JSON file that contains all the defined block
-     * options, keyed by block bundle. By default the file is output to
-     * .nuxt/blokkli/options-schema.json, but the path can be overriden here.
-     *
-     * The path can use aliases like ~ or @ and must also contain the file
-     * name including the extension.
-     */
-    schemaOptionsPath?: string;
-    /**
-     * Override the feature settings.
-     */
-    settingsOverride?: ModuleOptionsSettings;
-    /**
-     * The default storage values for non-settings values.
-     *
-     * These values are not visible in the settings dialog, but are still
-     * "settable" by the user through interactions. This option allows you to
-     * define default values for these settings, like default favorite block
-     * 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>;
 
-export { type ModuleOptions, _default as default };
+declare module '@nuxt/schema' {
+    interface NuxtHooks extends ModuleHooks {
+    }
+}
+
+export { ModuleOptions, _default as default };

package/dist/module.json

@@ -1,12 +1,12 @@
 {
   "name": "blokkli",
   "configKey": "blokkli",
-  "version": "1.4.0-alpha.1",
+  "version": "2.0.0-alpha.2",
   "compatibility": {
-    "nuxt": "^3.12.0"
+    "nuxt": "^3.15.0"
   },
   "builder": {
-    "@nuxt/module-builder": "0.8.4",
-    "unbuild": "2.0.0"
+    "@nuxt/module-builder": "1.0.1",
+    "unbuild": "3.5.0"
   }
 }