@crabs-dev/dtwo 0.4.9

package/README.md

@@ -0,0 +1,28 @@
+# `@crabs-dev/dtwo`
+
+> Dtwo 2 & 3 module
+
+## Installation
+
+```shell
+npm i @crabs-dev/dtwo
+```
+
+## Usage
+
+Add to `modules` (Dtwo 3) or `buildModules` (Dtwo 2) in `dtwo.config.js`:
+
+```js
+// Dtwo 2
+export default {
+  buildModules: [['@crabs-dev/dtwo', { disableKdux: true }]],
+}
+// Dtwo 3
+export default defineDtwoConfig({
+    modules: ['@crabs-dev/dtwo'],
+})
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -0,0 +1,29 @@
+import { DtwoModule } from '@dtwo/schema';
+
+interface ModuleOptions {
+    /**
+     * Crabs disables Kdux by default, set this option to `false` to avoid it and
+     * use Crabs alongside Kdux (Dtwo 2 only)
+     *
+     * @default `true`
+     */
+    disableKdux?: boolean;
+    /**
+     * Array of auto imports to be added to the dtwo.config.js file.
+     *
+     * @example
+     * ```js
+     * autoImports: [
+     *  // automatically import `defineStore`
+     *  'defineStore',
+     *  // automatically import `defineStore` as `defineCrabsStore`
+     *  ['defineStore', 'defineCrabsStore',
+     * ]
+     * ```
+     *
+     */
+    autoImports?: Array<string | [string, string]>;
+}
+declare const module: DtwoModule<ModuleOptions>;
+
+export { ModuleOptions, module as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "crabs",
+  "configKey": "crabs",
+  "compatibility": {
+    "dtwo": "^2.0.0 || ^3.0.0-rc.5",
+    "bridge": true
+  },
+  "version": "0.4.9"
+}

package/dist/module.mjs

@@ -0,0 +1,49 @@
+import { defineDtwoModule, createResolver, isDtwo2, resolveModule, addPlugin, addImports } from '@dtwo/kit';
+
+const module = defineDtwoModule({
+  meta: {
+    name: "crabs",
+    configKey: "crabs",
+    compatibility: {
+      dtwo: "^2.0.0 || ^3.0.0-rc.5",
+      bridge: true
+    }
+  },
+  defaults: {
+    disableKdux: true,
+    autoImports: []
+  },
+  setup(options, dtwo) {
+    const resolver = createResolver(import.meta.url);
+    if (
+      // @ts-expect-error: no feature flag anymore or private?
+      dtwo.options.features && // ts
+      options.disableKdux && isDtwo2()
+    ) {
+      dtwo.options.features.store = false;
+    }
+    dtwo.options.build.transpile.push(resolver.resolve("./runtime"));
+    dtwo.options.alias.crabs = dtwo.options.alias.crabs || resolveModule("crabs/dist/crabs.mjs", {
+      paths: [dtwo.options.rootDir, import.meta.url]
+    });
+    dtwo.hook("prepare:types", ({ references }) => {
+      references.push({ types: "@crabs-dev/dtwo" });
+    });
+    dtwo.hook("modules:done", () => {
+      if (isDtwo2()) {
+        addPlugin(resolver.resolve("./runtime/plugin.kdu2"));
+      } else {
+        addPlugin(resolver.resolve("./runtime/plugin.kdu3"));
+      }
+    });
+    const composables = resolver.resolve("./runtime/composables");
+    addImports([
+      { from: composables, name: "useDtwo" },
+      ...options.autoImports.map(
+        (imports) => typeof imports === "string" ? { from: composables, name: imports } : { from: composables, name: imports[0], as: imports[1] }
+      )
+    ]);
+  }
+});
+
+export { module as default };

package/dist/runtime/composables.d.ts

@@ -0,0 +1,2 @@
+export * from 'crabs-dev';
+export declare const useCrabs: () => any;

package/dist/runtime/composables.mjs

@@ -0,0 +1,3 @@
+import { useDtwoApp } from "#app";
+export * from "crabs-dev";
+export const useCrabs = () => useDtwoApp().$crabs;

package/dist/runtime/plugin.kdu2.d.ts

@@ -0,0 +1,13 @@
+declare const _default: (context: any, inject: any) => void;
+export default _default;
+declare module 'crabs' {
+    interface CrabsCustomProperties {
+        /**
+         * Dtwo context. Requires you to install `@dtwo/types` to have types.
+         *
+         * @deprecated use `useDtwoApp()` and global `$fetch()` instead. See
+         * https://dtwojs-v3.web.app/bridge/bridge-composition-api/
+         */
+        $dtwo: import('@dtwo/types').Context;
+    }
+}

package/dist/runtime/plugin.kdu2.mjs

@@ -0,0 +1,20 @@
+import _Kdu2 from "kdu";
+import { createCrabs, setActiveCrabs, CrabsKduPlugin } from "crabs-dev";
+const Kdu = "default" in _Kdu2 ? _Kdu2.default : _Kdu2;
+Kdu.use(CrabsKduPlugin);
+export default (context, inject) => {
+  const crabs = createCrabs();
+  context.app.crabs = crabs;
+  setActiveCrabs(crabs);
+  crabs._p.push(({ store }) => {
+    Object.defineProperty(store, "$dtwo", { value: context });
+  });
+  if (process.server) {
+    context.beforeDtwoRender((ctx) => {
+      ctx.dtwoState.crabs = crabs.state.value;
+    });
+  } else if (context.dtwoState && context.dtwoState.crabs) {
+    crabs.state.value = context.dtwoState.crabs;
+  }
+  inject("crabs", crabs);
+};

package/dist/runtime/plugin.kdu3.d.ts

@@ -0,0 +1,6 @@
+import type { Crabs } from 'crabs-dev';
+import { Plugin } from '#app';
+declare const plugin: Plugin<{
+    crabs: Crabs;
+}>;
+export default plugin;

package/dist/runtime/plugin.kdu3.mjs

@@ -0,0 +1,18 @@
+import { createCrabs, setActiveCrabs } from "crabs-dev";
+import { defineDtwoPlugin } from "#app";
+const plugin = defineDtwoPlugin((dtwoApp) => {
+  const crabs = createCrabs();
+  dtwoApp.kduApp.use(crabs);
+  setActiveCrabs(crabs);
+  if (process.server) {
+    dtwoApp.payload.crabs = crabs.state.value;
+  } else if (dtwoApp.payload && dtwoApp.payload.crabs) {
+    crabs.state.value = dtwoApp.payload.crabs;
+  }
+  return {
+    provide: {
+      crabs
+    }
+  };
+});
+export default plugin;

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+
+import { ModuleOptions } from './module'
+
+declare module '@dtwo/schema' {
+  interface DtwoConfig { ['crabs']?: Partial<ModuleOptions> }
+  interface DtwoOptions { ['crabs']?: ModuleOptions }
+}
+
+
+export { ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@crabs-dev/dtwo",
+  "version": "0.4.9",
+  "description": "Dtwo Module for crabs",
+  "keywords": [
+    "crabs",
+    "dtwo",
+    "kdu",
+    "kdux",
+    "store"
+  ],
+  "homepage": "https://github.com/kdujs/crabs/tree/v2/packages/dtwo#readme",
+  "bugs": {
+    "url": "https://github.com/kdujs/crabs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kdujs/crabs.git"
+  },
+  "license": "MIT",
+  "author": "NKDuy",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@dtwo/kit": "3.1.0",
+    "crabs-dev": "2.0.35"
+  },
+  "devDependencies": {
+    "@dtwo/module-builder": "0.2.1",
+    "@dtwo/schema": "3.1.0",
+    "@types/node": "18.15.11",
+    "dtwo": "3.1.0",
+    "kdu-tsc": "1.2.0",
+    "typescript": "5.0.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm dev:prepare && dtwo-module-build",
+    "dev": "dtwc dev playground",
+    "dev:build": "dtwc build playground",
+    "dev:prepare": "dtwo-module-build --stub && dtwc prepare playground"
+  }
+}