@dialecte/create 0.0.1

package/templates/dialecte/docs/index.md

@@ -0,0 +1,18 @@
+# **packageName**
+
+Dialecte SDK for `__dialecteId__`, generated with [`@dialecte/create`](https://github.com/dialecte/create).
+
+## Install
+
+```sh
+npm install __packageName__ @dialecte/core
+```
+
+## Usage
+
+```ts
+import { create__DialecteName__Project } from '__packageName__/__version__'
+
+const project = create__DialecteName__Project()
+await project.open('my-project')
+```

package/templates/dialecte/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/templates/dialecte/package.json

@@ -0,0 +1,45 @@
+{
+	"name": "__packageName__",
+	"version": "0.0.1",
+	"description": "Dialecte SDK for __dialecteId__",
+	"license": "MIT",
+	"type": "module",
+	"source": "src/index.ts",
+	"files": [
+		"dist"
+	],
+	"exports": {
+		"./__version__": {
+			"types": "./dist/__version__/index.d.ts",
+			"default": "./dist/__version__/index.js"
+		},
+		"./__version__/test": {
+			"types": "./dist/__version__/test.d.ts",
+			"default": "./dist/__version__/test.js"
+		}
+	},
+	"scripts": {
+		"build": "run-p type-check \"build-only {@}\" --",
+		"build-only": "tsc -p tsconfig.json && vite build",
+		"type-check": "tsc --noEmit",
+		"test": "vitest",
+		"doc:dev": "vitepress dev docs",
+		"doc:build": "vitepress build docs",
+		"doc:preview": "vitepress preview docs"
+	},
+	"dependencies": {
+		"@dialecte/core": "__coreVersion__"
+	},
+	"devDependencies": {
+		"@tsconfig/node24": "^24.0.4",
+		"@types/node": "^24.12.4",
+		"@vitest/browser-playwright": "^4.1.8",
+		"npm-run-all2": "^8.0.4",
+		"playwright": "^1.60.0",
+		"typescript": "^6.0.3",
+		"vite": "^8.0.16",
+		"vite-plugin-dts": "^5.0.2",
+		"vitepress": "^2.0.0-alpha.17",
+		"vitest": "^4.1.8"
+	}
+}

package/templates/dialecte/src/__version__/config/dialecte.config.ts

@@ -0,0 +1,48 @@
+import {
+	DEFINITION,
+	ELEMENT_NAMES,
+	ATTRIBUTES,
+	CHILDREN,
+	PARENTS,
+	DESCENDANTS,
+	ANCESTORS,
+	ROOT_ELEMENT,
+	SINGLETON_ELEMENTS,
+} from '../definition'
+import { __DIALECTE_NAME___NAMESPACES } from './namespaces'
+
+import type { IOConfig, AnyDialecteConfig, DatabaseConfig } from '@dialecte/core'
+
+// __DialecteName__-specific IO configuration
+export const __DIALECTE_NAME___IO_CONFIG = {
+	supportedFileExtensions: ['.xml'],
+} as const satisfies IOConfig
+
+// __DialecteName__ database configuration
+export const __DIALECTE_NAME___DATABASE_CONFIG = {
+	recordSchema: {
+		primaryKey: 'id',
+		indexes: ['tagName', 'parent.id', 'parent.tagName'],
+		compoundIndexes: [['id', 'tagName']],
+		arrayIndexes: ['children.id', 'children.tagName'],
+	},
+} as const satisfies DatabaseConfig
+
+export { __DIALECTE_NAME___NAMESPACES }
+
+export const __DIALECTE_NAME___DIALECTE_CONFIG = {
+	singletonElements: SINGLETON_ELEMENTS,
+	elements: ELEMENT_NAMES,
+	namespaces: __DIALECTE_NAME___NAMESPACES,
+	attributes: ATTRIBUTES,
+	children: CHILDREN,
+	parents: PARENTS,
+	descendants: DESCENDANTS,
+	ancestors: ANCESTORS,
+	database: __DIALECTE_NAME___DATABASE_CONFIG,
+	io: __DIALECTE_NAME___IO_CONFIG,
+	definition: DEFINITION,
+	rootElementName: ROOT_ELEMENT,
+} as const satisfies AnyDialecteConfig
+
+export type Config = Readonly<typeof __DIALECTE_NAME___DIALECTE_CONFIG>

package/templates/dialecte/src/__version__/config/hydrated.types.ts

@@ -0,0 +1,78 @@
+import type { Config } from './dialecte.config'
+import type { __DIALECTE_NAME___EXTENSION_MODULES } from '@/__version__/extensions'
+import type * as Core from '@dialecte/core'
+
+type __DialecteName__Extensions = Core.MergedExtensions<typeof __DIALECTE_NAME___EXTENSION_MODULES>
+
+export namespace __DialecteName__ {
+	export type Project<GenericCustomModules extends Core.ExtensionModules = Record<never, never>> =
+		Core.Project<Config, __DialecteName__Extensions & GenericCustomModules>
+	export type Document = Core.Document<Config, __DialecteName__Extensions>
+	export type Context = Core.Context<Config>
+
+	export type Query = Core.Query<Config> & Core.QueryExtensions<__DialecteName__Extensions>
+	export type Transaction = Core.Transaction<Config> &
+		Core.AllExtensions<__DialecteName__Extensions>
+	export type TransactionHooks = Core.TransactionHooks<Config>
+
+	// DEFINITION
+	export type ElementsOf = Core.ElementsOf<Config>
+	export type Ref<GenericElement extends ElementsOf> = Core.Ref<Config, GenericElement>
+	export type AttributesValueObjectOf<GenericElement extends ElementsOf> =
+		Core.AttributesValueObjectOf<Config, GenericElement>
+	export type AttributesOf<GenericElement extends ElementsOf> = Core.AttributesOf<
+		Config,
+		GenericElement
+	>
+	export type FullAttributeObjectOf<GenericElement extends ElementsOf> = Core.FullAttributeObjectOf<
+		Config,
+		GenericElement
+	>
+	export type ChildrenOf<GenericElement extends ElementsOf> = Core.ChildrenOf<
+		Config,
+		GenericElement
+	>
+	export type ParentsOf<GenericElement extends ElementsOf> = Core.ParentsOf<Config, GenericElement>
+	export type DescendantsOf<GenericElement extends ElementsOf> = Core.DescendantsOf<
+		Config,
+		GenericElement
+	>
+	export type AncestorsOf<GenericElement extends ElementsOf> = Core.AncestorsOf<
+		Config,
+		GenericElement
+	>
+	export type RootElementOf = Core.RootElementOf<Config>
+	export type SingletonElementsOf = Core.SingletonElementsOf<Config>
+
+	// OPERATIONS
+	export type Operation = Core.Operation<Config>
+
+	// RECORDS
+	export type RawRecord<GenericElement extends ElementsOf> = Core.RawRecord<Config, GenericElement>
+	export type TrackedRecord<GenericElement extends ElementsOf> = Core.TrackedRecord<
+		Config,
+		GenericElement
+	>
+	export type TreeRecord<GenericElement extends ElementsOf> = Core.TreeRecord<
+		Config,
+		GenericElement
+	>
+
+	export type ParentRelationship<GenericElement extends ElementsOf> = Core.ParentRelationship<
+		Config,
+		GenericElement
+	>
+	export type ChildRelationship<GenericElement extends ElementsOf> = Core.ChildRelationship<
+		Config,
+		GenericElement
+	>
+
+	export type Attribute<GenericElement extends ElementsOf> = Core.Attribute<Config, GenericElement>
+	export type QualifiedAttribute<GenericElement extends ElementsOf> = Core.QualifiedAttribute<
+		Config,
+		GenericElement
+	>
+
+	// MISCELLANEOUS
+	export type CloneMapping = Core.CloneMapping<Config>
+}

package/templates/dialecte/src/__version__/config/index.ts

@@ -0,0 +1,2 @@
+export * from './dialecte.config'
+export type * from './hydrated.types'

package/templates/dialecte/src/__version__/config/namespaces.ts

@@ -0,0 +1,6 @@
+import { XSI_NAMESPACE } from '@dialecte/core/helpers'
+
+export const __DIALECTE_NAME___NAMESPACES = {
+	default: { uri: '__namespaceUri__', prefix: '' },
+	xsi: XSI_NAMESPACE,
+} as const

package/templates/dialecte/src/__version__/definition/.gitkeep

@@ -0,0 +1,2 @@
+# Generated definition files are written here by `@dialecte/create`
+# (definition.generated.ts, constants.generated.ts, types.generated.ts).

package/templates/dialecte/src/__version__/definition/index.ts

@@ -0,0 +1,4 @@
+export * from './constants.generated'
+export * from './definition.generated'
+
+export type * from './types.generated'

package/templates/dialecte/src/__version__/dialecte.ts

@@ -0,0 +1,30 @@
+import { __DialecteName__ } from './config'
+import { __DIALECTE_NAME___DIALECTE_CONFIG } from './config/dialecte.config'
+import { __DIALECTE_NAME___EXTENSION_MODULES } from './extensions'
+
+import { Project } from '@dialecte/core'
+
+import type { StorageParam, ExtensionModules } from '@dialecte/core'
+
+/**
+ * Create a __DialecteName__ project with pre-configured config and extensions.
+ * Call .open(name) to initialize the store and hydrate state.
+ */
+export function create__DialecteName__Project<
+	CustomModules extends ExtensionModules = Record<never, never>,
+>(params?: {
+	storage?: StorageParam
+	extensions?: CustomModules
+}): __DialecteName__.Project<CustomModules> {
+	const { storage = { type: 'local' }, extensions } = params ?? {}
+
+	return new Project({
+		configs: { __dialecteId__: __DIALECTE_NAME___DIALECTE_CONFIG },
+		defaultConfigKey: '__dialecteId__',
+		storage,
+		extensions: {
+			base: __DIALECTE_NAME___EXTENSION_MODULES,
+			custom: extensions,
+		},
+	}) as __DialecteName__.Project<CustomModules>
+}

package/templates/dialecte/src/__version__/extensions/index.ts

@@ -0,0 +1,3 @@
+const __DIALECTE_NAME___EXTENSION_MODULES = {}
+
+export { __DIALECTE_NAME___EXTENSION_MODULES }

package/templates/dialecte/src/__version__/index.ts

@@ -0,0 +1,2 @@
+export * from './dialecte'
+export * from './config'

package/templates/dialecte/src/__version__/test/hydrated-test.ts

@@ -0,0 +1,53 @@
+import {
+	CUSTOM_RECORD_ID_ATTRIBUTE,
+	CUSTOM_RECORD_ID_ATTRIBUTE_NAME,
+	XMLNS_XSI_NAMESPACE,
+} from '@dialecte/core/helpers'
+import {
+	createTestProject,
+	createTestRecordFactory,
+	createXmlAssertions,
+	createTestRunner,
+	XMLNS_DEV_NAMESPACE,
+} from '@dialecte/core/test'
+
+import { __DIALECTE_NAME___DIALECTE_CONFIG } from '@/__version__/config'
+import { __DIALECTE_NAME___EXTENSION_MODULES } from '@/__version__/extensions'
+
+import type { Config } from '@/__version__/config/dialecte.config'
+
+type __DialecteName__Modules = typeof __DIALECTE_NAME___EXTENSION_MODULES
+
+export const XMLNS___DIALECTE_NAME___NAMESPACE = `xmlns="${__DIALECTE_NAME___DIALECTE_CONFIG.namespaces.default.uri}"`
+export const ALL_XMLNS_NAMESPACES = `${XMLNS___DIALECTE_NAME___NAMESPACE} ${XMLNS_DEV_NAMESPACE} ${XMLNS_XSI_NAMESPACE}`
+export { CUSTOM_RECORD_ID_ATTRIBUTE, CUSTOM_RECORD_ID_ATTRIBUTE_NAME }
+
+const __DIALECTE_NAME___EXTENSIONS = { base: __DIALECTE_NAME___EXTENSION_MODULES }
+
+export const run__DialecteName__TestCases = createTestRunner<Config, __DialecteName__Modules>({
+	dialecteConfig: __DIALECTE_NAME___DIALECTE_CONFIG,
+	extensions: __DIALECTE_NAME___EXTENSIONS,
+})
+
+export async function create__DialecteName__TestProject(params: {
+	sourceXml: string
+	targetXml?: string
+}) {
+	const { sourceXml, targetXml } = params
+
+	return createTestProject<Config, __DialecteName__Modules>({
+		sourceXml,
+		targetXml,
+		dialecteConfig: __DIALECTE_NAME___DIALECTE_CONFIG,
+		extensions: __DIALECTE_NAME___EXTENSIONS,
+	})
+}
+
+export const create__DialecteName__TestRecord: ReturnType<typeof createTestRecordFactory<Config>> =
+	createTestRecordFactory<Config>(__DIALECTE_NAME___DIALECTE_CONFIG)
+
+export const { assertExpectedElementQueries, assertUnexpectedElementQueries } = createXmlAssertions(
+	{
+		namespaces: __DIALECTE_NAME___DIALECTE_CONFIG.namespaces,
+	},
+)

package/templates/dialecte/src/__version__/test/index.ts

@@ -0,0 +1 @@
+export * from './hydrated-test'

package/templates/dialecte/src/index.ts

@@ -0,0 +1 @@
+export * from './__version__/dialecte'

package/templates/dialecte/tsconfig.build.json

@@ -0,0 +1,24 @@
+{
+	"extends": "@tsconfig/node24/tsconfig.json",
+	"compilerOptions": {
+		"noEmit": false,
+		"declaration": true,
+		"declarationMap": true,
+		"emitDeclarationOnly": true,
+		"outDir": "dist",
+		"rootDir": "src",
+		"module": "ESNext",
+		"target": "ES2019",
+		"moduleResolution": "Bundler",
+		"esModuleInterop": true,
+		"strict": true,
+		"skipLibCheck": true,
+		"lib": ["ESNext", "DOM"],
+		"resolveJsonModule": true,
+		"paths": {
+			"@/*": ["./src/*"]
+		}
+	},
+	"include": ["src/**/*"],
+	"exclude": ["**/*.test.ts", "**/__tests__/**"]
+}

package/templates/dialecte/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"files": [],
+	"references": [
+		{ "path": "./tsconfig.node.json" },
+		{ "path": "./tsconfig.vitest.json" },
+		{ "path": "./tsconfig.build.json" }
+	]
+}

package/templates/dialecte/tsconfig.node.json

@@ -0,0 +1,13 @@
+{
+	"extends": "@tsconfig/node24/tsconfig.json",
+	"include": ["vite.config.*", "vitest.config.*"],
+	"compilerOptions": {
+		"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+		"module": "ESNext",
+		"moduleResolution": "Bundler",
+		"types": ["node"],
+		"paths": {
+			"@/*": ["./src/*"]
+		}
+	}
+}

package/templates/dialecte/tsconfig.vitest.json

@@ -0,0 +1,10 @@
+{
+	"extends": "./tsconfig.node.json",
+	"include": ["src/**/*.test.ts", "env.d.ts"],
+	"exclude": [],
+	"compilerOptions": {
+		"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.vitest.tsbuildinfo",
+		"lib": ["DOM", "DOM.Iterable", "ESNext"],
+		"types": ["node"]
+	}
+}

package/templates/dialecte/vite.config.ts

@@ -0,0 +1,36 @@
+import path from 'node:path'
+/// <reference types="vite/client" />
+import { fileURLToPath, URL } from 'node:url'
+
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+
+export default defineConfig({
+	plugins: [
+		dts({
+			tsconfigPath: path.resolve(__dirname, './tsconfig.build.json'),
+			insertTypesEntry: true,
+		}),
+	],
+	resolve: {
+		alias: {
+			'@': fileURLToPath(new URL('./src', import.meta.url)),
+		},
+	},
+	build: {
+		sourcemap: import.meta.env?.DEV,
+		lib: {
+			entry: {
+				'__version__/index': fileURLToPath(new URL('./src/__version__/index.ts', import.meta.url)),
+				'__version__/test': fileURLToPath(
+					new URL('./src/__version__/test/index.ts', import.meta.url),
+				),
+			},
+			name: '__DialecteName__Dialecte',
+			formats: ['es'],
+		},
+		rollupOptions: {
+			external: [/^@dialecte\/core/],
+		},
+	},
+})

package/templates/dialecte/vitest.config.ts

@@ -0,0 +1,35 @@
+import { fileURLToPath } from 'node:url'
+
+import viteConfig from './vite.config'
+
+import { playwright } from '@vitest/browser-playwright'
+import { mergeConfig, defineConfig, configDefaults } from 'vitest/config'
+
+export default mergeConfig(
+	viteConfig,
+	defineConfig({
+		test: {
+			watch: false,
+			testTimeout: 5_000,
+			projects: [
+				{
+					resolve: viteConfig.resolve,
+					plugins: [],
+					test: {
+						name: 'unit',
+						browser: {
+							provider: playwright(),
+							enabled: true,
+							headless: true,
+							instances: [{ browser: 'chromium' }],
+							screenshotFailures: false,
+						},
+						include: ['src/**/*.test.{js,ts,jsx,tsx}'],
+						exclude: [...configDefaults.exclude],
+						root: fileURLToPath(new URL('./', import.meta.url)),
+					},
+				},
+			],
+		},
+	}),
+)