ngwr 6.1.1 → 7.1.0

package/schematics/provider/index.js

@@ -0,0 +1,126 @@
+"use strict";
+/**
+ * @license
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const schematics_1 = require("@angular-devkit/schematics");
+const workspace_1 = require("@schematics/angular/utility/workspace");
+const PROVIDERS = {
+    overlay: { subpath: 'ngwr/overlay', factory: 'provideWrOverlay', call: 'provideWrOverlay()' },
+    icons: {
+        subpath: 'ngwr/icon',
+        factory: 'provideWrIcons',
+        call: 'provideWrIcons([plus, trash])',
+        extras: [['plus, trash', 'ngwr/icon']],
+    },
+    toast: { subpath: 'ngwr/toast', factory: 'provideWrToast', call: 'provideWrToast()' },
+    i18n: { subpath: 'ngwr/i18n', factory: 'provideWrI18n', call: 'provideWrI18n()' },
+    'date-adapter': {
+        subpath: 'ngwr/date-adapter',
+        factory: 'provideWrDateAdapter',
+        call: 'provideWrDateAdapter()',
+    },
+    density: { subpath: 'ngwr/density', factory: 'provideWrDensity', call: 'provideWrDensity()' },
+    'loading-bar': {
+        subpath: 'ngwr/loading-bar',
+        factory: 'provideWrLoadingBar',
+        call: 'provideWrLoadingBar()',
+    },
+    cookie: { subpath: 'ngwr/cookie', factory: 'provideWrCookie', call: 'provideWrCookie()' },
+    storage: { subpath: 'ngwr/storage', factory: 'provideWrStorage', call: 'provideWrStorage()' },
+    theme: { subpath: 'ngwr/theme', factory: 'provideWrTheme', call: 'provideWrTheme()' },
+};
+function provider(options) {
+    return async (tree, context) => {
+        const spec = PROVIDERS[options.name];
+        if (!spec)
+            throw new schematics_1.SchematicsException(`ngwr:provider: unknown provider "${options.name}".`);
+        const filePath = await resolveMainFile(tree, options);
+        if (!filePath) {
+            context.logger.info(printSnippet(spec));
+            return tree;
+        }
+        const original = tree.readText(filePath);
+        let next = original;
+        next = ensureImport(next, spec.factory, spec.subpath);
+        if (options.name === 'icons') {
+            next = ensureImport(next, 'plus', 'ngwr/icon');
+            next = ensureImport(next, 'trash', 'ngwr/icon');
+        }
+        next = ensureProviderCall(next, spec.call);
+        if (next === original) {
+            context.logger.info(`ngwr:provider: ${filePath} already has ${spec.factory} — no changes.`);
+            return tree;
+        }
+        tree.overwrite(filePath, next);
+        context.logger.info(`✓ Added ${spec.call} to ${filePath}.`);
+        return tree;
+    };
+}
+async function resolveMainFile(tree, options) {
+    if (options.path && tree.exists(options.path))
+        return options.path;
+    const workspace = await (0, workspace_1.getWorkspace)(tree);
+    const projectName = options.project ?? workspace.extensions.defaultProject;
+    const project = (projectName && workspace.projects.get(projectName)) ?? workspace.projects.values().next().value;
+    if (!project)
+        return null;
+    const main = project.targets.get('build')?.options?.main;
+    const browser = project.targets.get('build')?.options?.browser;
+    const candidate = main ?? browser ?? `${project.sourceRoot ?? 'src'}/main.ts`;
+    return tree.exists(candidate) ? candidate : null;
+}
+function ensureImport(source, symbol, subpath) {
+    if (new RegExp(`\\bimport\\s*\\{[^}]*\\b${symbol}\\b[^}]*\\}\\s*from`).test(source))
+        return source;
+    const sameRe = new RegExp(`(import\\s*\\{)([^}]*)(\\}\\s*from\\s*['"]${escapeRegExp(subpath)}['"])`, 'm');
+    const sameMatch = sameRe.exec(source);
+    if (sameMatch) {
+        const head = sameMatch[1];
+        const body = sameMatch[2].trim().replace(/,\s*$/, '');
+        const tail = sameMatch[3];
+        const merged = body ? `${head} ${body}, ${symbol} ${tail}` : `${head} ${symbol} ${tail}`;
+        return source.replace(sameMatch[0], merged);
+    }
+    const blockRe = /(^|\n)(import\s[^;]+;\s*\n)+/m;
+    const block = blockRe.exec(source);
+    const newLine = `import { ${symbol} } from '${subpath}';\n`;
+    if (block) {
+        const end = (block.index ?? 0) + block[0].length;
+        return `${source.slice(0, end)}${newLine}${source.slice(end)}`;
+    }
+    return `${newLine}${source}`;
+}
+function ensureProviderCall(source, call) {
+    // Splice into the providers array of bootstrapApplication / ApplicationConfig.
+    const arrayRe = /(\bproviders\s*:\s*\[)([\s\S]*?)(\])/m;
+    const match = arrayRe.exec(source);
+    if (!match)
+        return source;
+    // Already present?
+    const callBase = call.split('(')[0];
+    if (new RegExp(`\\b${escapeRegExp(callBase)}\\s*\\(`).test(match[2]))
+        return source;
+    const trimmed = match[2].replace(/\s+$/, '');
+    const sep = trimmed.length && !trimmed.endsWith(',') ? ', ' : trimmed.length ? ' ' : '';
+    const replaced = `${match[1]}${trimmed}${sep}${call}${match[3]}`;
+    return source.replace(match[0], replaced);
+}
+function escapeRegExp(value) {
+    return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+function printSnippet(spec) {
+    return `
+ngwr:provider — copy this into your bootstrap:
+
+  import { ${spec.factory} } from '${spec.subpath}';
+
+  bootstrapApplication(AppComponent, {
+    providers: [/* …, */ ${spec.call}],
+  });
+`;
+}
+exports.default = provider;

package/schematics/provider/schema.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * @license
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/schematics/provider/schema.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "ngwr-provider",
+  "title": "ngwr provider",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "enum": [
+        "overlay",
+        "icons",
+        "toast",
+        "i18n",
+        "date-adapter",
+        "density",
+        "loading-bar",
+        "cookie",
+        "storage",
+        "theme"
+      ],
+      "description": "Provider to add.",
+      "$default": { "$source": "argv", "index": 0 },
+      "x-prompt": {
+        "message": "Which provider?",
+        "type": "list",
+        "items": [
+          { "value": "overlay", "label": "overlay — required for every overlay-backed component" },
+          { "value": "icons", "label": "icons — register a tree-shaken icon set" },
+          { "value": "toast", "label": "toast — global toast service" },
+          { "value": "i18n", "label": "i18n — Transloco-class translation core" },
+          { "value": "date-adapter", "label": "date-adapter — calendar / date-picker plumbing" },
+          { "value": "density", "label": "density — comfortable / compact preset" },
+          { "value": "loading-bar", "label": "loading-bar — router-aware progress bar" },
+          { "value": "cookie", "label": "cookie — wr cookie service" },
+          { "value": "storage", "label": "storage — swappable engine + TTL" },
+          { "value": "theme", "label": "theme — light/dark/auto mode" }
+        ]
+      }
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "Main entry file to patch. Defaults to the first match in `src/main.ts`."
+    },
+    "project": {
+      "type": "string",
+      "description": "Target Angular project.",
+      "$default": { "$source": "projectName" }
+    }
+  },
+  "required": ["name"]
+}

package/schematics/use/index.js

@@ -0,0 +1,143 @@
+"use strict";
+/**
+ * @license
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const schematics_1 = require("@angular-devkit/schematics");
+// Bundled at build time by `scripts/build-symbol-map.ts`. Map of every
+// `Wr*` public symbol → the subpath it lives under.
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const SYMBOL_MAP = require('./symbol-map.json');
+/**
+ * Add `import { WrFoo } from 'ngwr/<subpath>';` to the given component
+ * file and splice `WrFoo` into the `@Component({ imports: [...] })`
+ * array. Saves the subpath-lookup dance for newcomers — `ng g ngwr:use
+ * WrButton src/app/my-page.ts`.
+ *
+ * Regex-based on purpose to avoid pulling in the TS compiler as a runtime
+ * dep. Covers the common standalone-component shape; an unusual file
+ * shape gets a clear warning + a copy-pasteable snippet.
+ */
+function use(options) {
+    return (tree, context) => {
+        const symbol = options.symbol.trim();
+        if (!symbol)
+            throw new schematics_1.SchematicsException('ngwr:use: missing required `symbol`.');
+        const subpath = SYMBOL_MAP[symbol];
+        if (!subpath) {
+            throw new schematics_1.SchematicsException(`ngwr:use: unknown symbol "${symbol}". Check the catalog at https://ngwr.dev or use the literal import: \`import { ${symbol} } from 'ngwr/<subpath>';\``);
+        }
+        const filePath = resolveTargetFile(tree, options.path);
+        if (!filePath) {
+            // No file passed: just print the import snippet and stop.
+            context.logger.info(printManualSnippet(symbol, subpath));
+            return tree;
+        }
+        if (!tree.exists(filePath)) {
+            throw new schematics_1.SchematicsException(`ngwr:use: file ${filePath} not found.`);
+        }
+        const original = tree.readText(filePath);
+        let next = original;
+        next = addImport(next, symbol, subpath);
+        next = addToImportsArray(next, symbol);
+        if (next === original) {
+            context.logger.info(`ngwr:use: ${filePath} already has ${symbol} — no changes.`);
+            return tree;
+        }
+        tree.overwrite(filePath, next);
+        context.logger.info(`✓ Added ${symbol} (from ${subpath}) to ${filePath}.`);
+        return tree;
+    };
+}
+function resolveTargetFile(tree, candidate) {
+    if (!candidate)
+        return null;
+    const path = candidate.startsWith('/') ? candidate : `/${candidate}`;
+    if (tree.exists(path))
+        return path;
+    if (tree.exists(candidate))
+        return candidate;
+    return null;
+}
+/**
+ * Insert `import { Symbol } from 'subpath';` near the existing imports,
+ * or merge into an existing line that already references the same path.
+ * Idempotent — returns the source untouched if the symbol is already in.
+ */
+function addImport(source, symbol, subpath) {
+    // Already imported from somewhere?
+    const importedAnywhere = new RegExp(`\\bimport\\s*\\{[^}]*\\b${symbol}\\b[^}]*\\}\\s*from`).test(source);
+    if (importedAnywhere)
+        return source;
+    // Existing import from the same subpath? — splice the symbol in.
+    const sameSubpathRe = new RegExp(`(import\\s*\\{)([^}]*)(\\}\\s*from\\s*['"]${escapeRegExp(subpath)}['"])`, 'm');
+    const sameSubpathMatch = sameSubpathRe.exec(source);
+    if (sameSubpathMatch) {
+        const head = sameSubpathMatch[1];
+        const body = sameSubpathMatch[2].trim().replace(/,\s*$/, '');
+        const tail = sameSubpathMatch[3];
+        const merged = body ? `${head} ${body}, ${symbol} ${tail}` : `${head} ${symbol} ${tail}`;
+        return source.replace(sameSubpathMatch[0], merged);
+    }
+    // No related import — prepend a new line after the last top-of-file
+    // import we can find.
+    const importBlockRe = /(^|\n)(import\s[^;]+;\s*\n)+/m;
+    const block = importBlockRe.exec(source);
+    const newLine = `import { ${symbol} } from '${subpath}';\n`;
+    if (block) {
+        // Splice in immediately after the last import in the block.
+        const end = (block.index ?? 0) + block[0].length;
+        return `${source.slice(0, end)}${newLine}${source.slice(end)}`;
+    }
+    // No existing imports — just prepend.
+    return `${newLine}${source}`;
+}
+/**
+ * Find `imports: [...]` inside a `@Component({...})` decorator (single or
+ * multi-line) and splice the symbol in. Skips if the symbol is already
+ * listed.
+ */
+function addToImportsArray(source, symbol) {
+    // Match `imports: [ ... ]` allowing multi-line + trailing commas.
+    const arrayRe = /(\bimports\s*:\s*\[)([\s\S]*?)(\])/m;
+    const match = arrayRe.exec(source);
+    if (!match) {
+        // No imports array — try to insert one after the `@Component({`
+        // opening brace. Heuristic, not foolproof.
+        const componentRe = /@Component\s*\(\s*\{/;
+        const compMatch = componentRe.exec(source);
+        if (compMatch?.index === undefined) {
+            // No @Component decorator at all — leave the file alone, the user
+            // probably wants the import only.
+            return source;
+        }
+        const insertAt = compMatch.index + compMatch[0].length;
+        return `${source.slice(0, insertAt)}\n  imports: [${symbol}],${source.slice(insertAt)}`;
+    }
+    const body = match[2];
+    if (new RegExp(`\\b${escapeRegExp(symbol)}\\b`).test(body))
+        return source;
+    const trimmed = body.replace(/\s+$/, '');
+    const sep = trimmed.length && !trimmed.endsWith(',') ? ', ' : trimmed.length ? ' ' : '';
+    const replaced = `${match[1]}${trimmed}${sep}${symbol}${match[3]}`;
+    return source.replace(match[0], replaced);
+}
+function escapeRegExp(value) {
+    return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+function printManualSnippet(symbol, subpath) {
+    return `
+ngwr:use — copy this into your component:
+
+  import { ${symbol} } from '${subpath}';
+
+  @Component({
+    imports: [/* …, */ ${symbol}],
+    /* … */
+  })
+`;
+}
+exports.default = use;

package/schematics/use/schema.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * @license
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/schematics/use/schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "ngwr-use",
+  "title": "ngwr use",
+  "type": "object",
+  "properties": {
+    "symbol": {
+      "type": "string",
+      "description": "Class name to import — e.g. `WrButton`, `WrSelect`, `WrFormField`.",
+      "$default": { "$source": "argv", "index": 0 },
+      "x-prompt": "Class name to import (e.g. WrButton)?"
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "Component file to edit. When omitted, uses the file passed via argv[1] or prompts."
+    },
+    "project": {
+      "type": "string",
+      "description": "Target Angular project. Defaults to the workspace default.",
+      "$default": { "$source": "projectName" }
+    }
+  },
+  "required": ["symbol"]
+}