@keycloakify/angular 0.0.8 → 0.0.10

package/README.md

@@ -25,51 +25,29 @@
         -
         <a href="https://docs.keycloakify.dev">Documentation</a>
         -
-        <a href="https://storybook.keycloakify.dev">Storybook</a>
+        <a href="https://github.com/keycloakify/keycloakify-starter-angular-vite">Starter Project Vite (Recommended)</a>
         -
-        <a href="https://github.com/keycloakify/keycloakify-starter-angular">Starter project</a>
-        -
-        <a href="https://github.com/keycloakify/keycloakify-starter-angular-vite">Starter project (Vite)</a>
+        <a href="https://github.com/keycloakify/keycloakify-starter-angular-webpack">Starter Project Webpack</a>
     </p>
 </p>
 
-> **Note:** This library is under active development, we do not recommend implementing it just yet.
-
 ## Using the library
 
-```bash
-npm install keycloakify @keycloakify/angular
-```
-
-or using yarn:
-
-```bash
-yarn add keycloakify @keycloakify/angular
-```
-
-## Developing the library
+Don't it's not ready yet. Subscribe to alerts on the repo to get notified when it is.
 
-If you want to make changes to the library make sure to follow these steps to setup your local environment.
+## Contributing
 
-### In the library:
+> **Note:**: This is **not** for using the library, but for contributing to it.
 
-1. Run `yarn link-in-starter`
-
-### In the starter:
+```bash
+git clone https://github.com/keycloakify/keycloakify-angular
+git clone https://github.com/keycloakify/keycloakify-angular-starter-vite
+git clone https://github.com/keycloakify/keycloakify-angular-starter-webpack
 
-1. You need to make configurations in `angular.json`:
-    - **Firstly**, make sure that `preserveSymlinks` is set to `true`:
-        ```json
-        "preserveSymlinks": true
-        ```
-    - **Secondly**, disable caching under `cli`:
-        ```json
-        "cli": {
-          "cache": {
-            "enabled": false
-          }
-        }
-        ```
-2. `ng serve`
+cd keycloakify-angular
+yarn install
+yarn link-in-starter # When prompted select the starter you want to link into
 
-You are good to go 🚀
+# At this point you can navigate to the starter you've picked.
+# The changes in the library will be reflected live in the starter.
+```

package/bin/338.index.js

@@ -251,20 +251,24 @@ function runFormat(params) {
 /* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(fs__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(928);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_1__);
-/* harmony import */ var _tools_runFormat__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(49);
+/* harmony import */ var _tools_runFormat__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(49);
+/* harmony import */ var crypto__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(982);
+/* harmony import */ var crypto__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(crypto__WEBPACK_IMPORTED_MODULE_2__);
+
 
 
 
 function command(params) {
     const { buildContext } = params;
     const filePath = (0,path__WEBPACK_IMPORTED_MODULE_1__.join)(buildContext.themeSrcDirPath, 'kc.gen.ts');
-    const currentContent = fs__WEBPACK_IMPORTED_MODULE_0__.existsSync(filePath)
-        ? fs__WEBPACK_IMPORTED_MODULE_0__.readFileSync(filePath)
-        : undefined;
     const implementedThemeTypes = ['login', 'account'].filter(themeType => buildContext.implementedThemeTypes[themeType].isImplemented);
-    const newContent = Buffer.from([
+    const newContent = [
+        ``,
+        `/* eslint-disable */`,
+        ``,
+        `// @ts-nocheck`,
         ``,
-        `// This file is auto-generated by Keycloakify, do not modify it manually.`,
+        `// noinspection JSUnusedGlobalSymbols`,
         ``,
         `import type { ComponentRef, EnvironmentProviders, Type } from "@angular/core";`,
         ``,
@@ -289,7 +293,6 @@ function command(params) {
         `}`,
         ``,
         `type ApplicationRefLike = {`,
-        `    // eslint-disable-next-line @typescript-eslint/no-explicit-any`,
         `    components: ComponentRef<any>[];`,
         `};`,
         ``,
@@ -364,12 +367,25 @@ function command(params) {
         `    }`,
         `}`,
         ``
-    ].join('\n'), 'utf8');
-    if (currentContent !== undefined && currentContent.equals(newContent)) {
+    ].join('\n');
+    const hash = crypto__WEBPACK_IMPORTED_MODULE_2__.createHash('sha256').update(newContent).digest('hex');
+    skip_if_no_changes: {
+        if (!fs__WEBPACK_IMPORTED_MODULE_0__.existsSync(filePath)) {
+            break skip_if_no_changes;
+        }
+        const currentContent = fs__WEBPACK_IMPORTED_MODULE_0__.readFileSync(filePath).toString('utf8');
+        if (!currentContent.includes(hash)) {
+            break skip_if_no_changes;
+        }
         return;
     }
-    fs__WEBPACK_IMPORTED_MODULE_0__.writeFileSync(filePath, newContent);
-    (0,_tools_runFormat__WEBPACK_IMPORTED_MODULE_2__/* .runFormat */ .J)({ packageJsonFilePath: buildContext.packageJsonFilePath });
+    fs__WEBPACK_IMPORTED_MODULE_0__.writeFileSync(filePath, Buffer.from([
+        `// This file is auto-generated by keycloakify. Do not edit it manually.`,
+        `// Hash: ${hash}`,
+        ``,
+        newContent
+    ].join('\n'), 'utf8'));
+    (0,_tools_runFormat__WEBPACK_IMPORTED_MODULE_3__/* .runFormat */ .J)({ packageJsonFilePath: buildContext.packageJsonFilePath });
 }
 
 

package/bin/758.index.js

@@ -79,20 +79,24 @@ function runFormat(params) {
 /* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(fs__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(928);
 /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_1__);
-/* harmony import */ var _tools_runFormat__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(49);
+/* harmony import */ var _tools_runFormat__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(49);
+/* harmony import */ var crypto__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(982);
+/* harmony import */ var crypto__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(crypto__WEBPACK_IMPORTED_MODULE_2__);
+
 
 
 
 function command(params) {
     const { buildContext } = params;
     const filePath = (0,path__WEBPACK_IMPORTED_MODULE_1__.join)(buildContext.themeSrcDirPath, 'kc.gen.ts');
-    const currentContent = fs__WEBPACK_IMPORTED_MODULE_0__.existsSync(filePath)
-        ? fs__WEBPACK_IMPORTED_MODULE_0__.readFileSync(filePath)
-        : undefined;
     const implementedThemeTypes = ['login', 'account'].filter(themeType => buildContext.implementedThemeTypes[themeType].isImplemented);
-    const newContent = Buffer.from([
+    const newContent = [
+        ``,
+        `/* eslint-disable */`,
+        ``,
+        `// @ts-nocheck`,
         ``,
-        `// This file is auto-generated by Keycloakify, do not modify it manually.`,
+        `// noinspection JSUnusedGlobalSymbols`,
         ``,
         `import type { ComponentRef, EnvironmentProviders, Type } from "@angular/core";`,
         ``,
@@ -117,7 +121,6 @@ function command(params) {
         `}`,
         ``,
         `type ApplicationRefLike = {`,
-        `    // eslint-disable-next-line @typescript-eslint/no-explicit-any`,
         `    components: ComponentRef<any>[];`,
         `};`,
         ``,
@@ -192,12 +195,25 @@ function command(params) {
         `    }`,
         `}`,
         ``
-    ].join('\n'), 'utf8');
-    if (currentContent !== undefined && currentContent.equals(newContent)) {
+    ].join('\n');
+    const hash = crypto__WEBPACK_IMPORTED_MODULE_2__.createHash('sha256').update(newContent).digest('hex');
+    skip_if_no_changes: {
+        if (!fs__WEBPACK_IMPORTED_MODULE_0__.existsSync(filePath)) {
+            break skip_if_no_changes;
+        }
+        const currentContent = fs__WEBPACK_IMPORTED_MODULE_0__.readFileSync(filePath).toString('utf8');
+        if (!currentContent.includes(hash)) {
+            break skip_if_no_changes;
+        }
         return;
     }
-    fs__WEBPACK_IMPORTED_MODULE_0__.writeFileSync(filePath, newContent);
-    (0,_tools_runFormat__WEBPACK_IMPORTED_MODULE_2__/* .runFormat */ .J)({ packageJsonFilePath: buildContext.packageJsonFilePath });
+    fs__WEBPACK_IMPORTED_MODULE_0__.writeFileSync(filePath, Buffer.from([
+        `// This file is auto-generated by keycloakify. Do not edit it manually.`,
+        `// Hash: ${hash}`,
+        ``,
+        newContent
+    ].join('\n'), 'utf8'));
+    (0,_tools_runFormat__WEBPACK_IMPORTED_MODULE_3__/* .runFormat */ .J)({ packageJsonFilePath: buildContext.packageJsonFilePath });
 }
 
 

package/bin/main.js

@@ -88,6 +88,13 @@ module.exports = require("child_process");
 
 /***/ }),
 
+/***/ 982:
+/***/ ((module) => {
+
+module.exports = require("crypto");
+
+/***/ }),
+
 /***/ 896:
 /***/ ((module) => {
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@keycloakify/angular",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "peerDependencies": {
-    "keycloakify": "^11.3.10",
+    "keycloakify": "^11.3.12",
     "@angular/core": "^18.0.0",
     "@angular/common": "^18.0.0",
     "@angular/platform-browser": "^18.0.0"

package/src/bin/update-kc-gen.ts

@@ -2,145 +2,164 @@ import type { BuildContext } from './core';
 import * as fs from 'fs';
 import { join as pathJoin } from 'path';
 import { runFormat } from './tools/runFormat';
+import * as crypto from 'crypto';
 
 export function command(params: { buildContext: BuildContext }) {
     const { buildContext } = params;
 
     const filePath = pathJoin(buildContext.themeSrcDirPath, 'kc.gen.ts');
 
-    const currentContent = fs.existsSync(filePath)
-        ? fs.readFileSync(filePath)
-        : undefined;
-
     const implementedThemeTypes = (['login', 'account'] as const).filter(
         themeType => buildContext.implementedThemeTypes[themeType].isImplemented
     );
 
-    const newContent = Buffer.from(
-        [
-            ``,
-            `// This file is auto-generated by Keycloakify, do not modify it manually.`,
-            ``,
-            `import type { ComponentRef, EnvironmentProviders, Type } from "@angular/core";`,
-            ``,
-            `export type ThemeName = ${buildContext.themeNames.map(themeName => `"${themeName}"`).join(' | ')};`,
-            ``,
-            `export const themeNames: ThemeName[] = [${buildContext.themeNames.map(themeName => `"${themeName}"`).join(', ')}];`,
-            ``,
-            `export type KcEnvName = ${buildContext.environmentVariables.length === 0 ? 'never' : buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(' | ')};`,
-            ``,
-            `export const kcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(', ')}];`,
-            ``,
-            `export const kcEnvDefaults: Record<KcEnvName, string> = ${JSON.stringify(
-                Object.fromEntries(
-                    buildContext.environmentVariables.map(
-                        ({ name, default: defaultValue }) => [name, defaultValue]
-                    )
-                ),
-                null,
-                2
-            )};`,
-            ``,
-            `export type KcContext =`,
-            ...implementedThemeTypes.map(
-                themeType => `    | import("./${themeType}/KcContext").KcContext`
-            ),
-            `    ;`,
-            ``,
-            `declare global {`,
-            `    interface Window {`,
-            `        kcContext?: KcContext;`,
-            `    }`,
-            `}`,
-            ``,
-            `type ApplicationRefLike = {`,
-            `    // eslint-disable-next-line @typescript-eslint/no-explicit-any`,
-            `    components: ComponentRef<any>[];`,
-            `};`,
-            ``,
-            `export async function bootstrapKcApplication(params: {`,
-            `    kcContext: KcContext;`,
-            `    bootstrapApplication: (params: {`,
-            `        KcRootComponent: Type<unknown>;`,
-            `        kcProvider: EnvironmentProviders;`,
-            `    }) => Promise<ApplicationRefLike>;`,
-            `}) {`,
-            `    const { kcContext, bootstrapApplication } = params;`,
-            ``,
-            `    switch (kcContext.themeType) {`,
-            ...(['login', 'account'] as const)
-                .filter(
-                    themeType =>
-                        buildContext.implementedThemeTypes[themeType].isImplemented
+    const newContent = [
+        ``,
+        `/* eslint-disable */`,
+        ``,
+        `// @ts-nocheck`,
+        ``,
+        `// noinspection JSUnusedGlobalSymbols`,
+        ``,
+        `import type { ComponentRef, EnvironmentProviders, Type } from "@angular/core";`,
+        ``,
+        `export type ThemeName = ${buildContext.themeNames.map(themeName => `"${themeName}"`).join(' | ')};`,
+        ``,
+        `export const themeNames: ThemeName[] = [${buildContext.themeNames.map(themeName => `"${themeName}"`).join(', ')}];`,
+        ``,
+        `export type KcEnvName = ${buildContext.environmentVariables.length === 0 ? 'never' : buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(' | ')};`,
+        ``,
+        `export const kcEnvNames: KcEnvName[] = [${buildContext.environmentVariables.map(({ name }) => `"${name}"`).join(', ')}];`,
+        ``,
+        `export const kcEnvDefaults: Record<KcEnvName, string> = ${JSON.stringify(
+            Object.fromEntries(
+                buildContext.environmentVariables.map(
+                    ({ name, default: defaultValue }) => [name, defaultValue]
                 )
-                .map(themeType => [
-                    `        case "${themeType}":`,
-                    `            {`,
-                    `                const [`,
-                    `                    { provideKeycloakifyAngular },`,
-                    `                    { getI18n },`,
-                    `                    {`,
-                    `                        PageComponent,`,
-                    `                        TemplateComponent,`,
-                    `                        doUseDefaultCss,`,
-                    `                        classes,`,
-                    ...(themeType === 'login'
-                        ? [
-                              `                        UserProfileFormFieldsComponent,`,
-                              `                        doMakeUserConfirmPassword,`
-                          ]
-                        : []),
-                    `                    },`,
-                    `                ] = await Promise.all([`,
-                    `                    import('@keycloakify/angular/login/providers/keycloakify-angular'),`,
-                    `                    import('./${themeType}/i18n'),`,
-                    `                    import('./${themeType}/KcPage').then(({ getKcPage }) => getKcPage(kcContext.pageId)),`,
-                    `                ] as const);`,
-                    ``,
-                    `                const appRef = await bootstrapApplication({`,
-                    `                    KcRootComponent: TemplateComponent,`,
-                    `                    kcProvider: provideKeycloakifyAngular({`,
-                    `                        kcContext,`,
-                    `                        classes,`,
-                    `                        getI18n,`,
-                    `                        doUseDefaultCss,`,
-                    ...(themeType === 'login'
-                        ? [`                        doMakeUserConfirmPassword,`]
-                        : []),
-                    `                    })`,
-                    `                });`,
-                    ``,
-                    `                appRef.components.forEach(componentRef => {`,
-                    `                    if ("page" in componentRef.instance) {`,
-                    `                        componentRef.setInput("page", PageComponent);`,
-                    `                    }`,
-                    ...(themeType === 'login'
-                        ? [
-                              `                    if ("userProfileFormFields" in componentRef.instance) {`,
-                              `                        componentRef.setInput(`,
-                              `                            "userProfileFormFields",`,
-                              `                            UserProfileFormFieldsComponent`,
-                              `                        );`,
-                              `                    }`
-                          ]
-                        : []),
-                    `                });`,
-                    `            }`,
-                    `            break;`
-                ])
-                .flat(),
-            `    }`,
-            `}`,
-            ``
-        ].join('\n'),
-        'utf8'
-    );
+            ),
+            null,
+            2
+        )};`,
+        ``,
+        `export type KcContext =`,
+        ...implementedThemeTypes.map(
+            themeType => `    | import("./${themeType}/KcContext").KcContext`
+        ),
+        `    ;`,
+        ``,
+        `declare global {`,
+        `    interface Window {`,
+        `        kcContext?: KcContext;`,
+        `    }`,
+        `}`,
+        ``,
+        `type ApplicationRefLike = {`,
+        `    components: ComponentRef<any>[];`,
+        `};`,
+        ``,
+        `export async function bootstrapKcApplication(params: {`,
+        `    kcContext: KcContext;`,
+        `    bootstrapApplication: (params: {`,
+        `        KcRootComponent: Type<unknown>;`,
+        `        kcProvider: EnvironmentProviders;`,
+        `    }) => Promise<ApplicationRefLike>;`,
+        `}) {`,
+        `    const { kcContext, bootstrapApplication } = params;`,
+        ``,
+        `    switch (kcContext.themeType) {`,
+        ...(['login', 'account'] as const)
+            .filter(
+                themeType => buildContext.implementedThemeTypes[themeType].isImplemented
+            )
+            .map(themeType => [
+                `        case "${themeType}":`,
+                `            {`,
+                `                const [`,
+                `                    { provideKeycloakifyAngular },`,
+                `                    { getI18n },`,
+                `                    {`,
+                `                        PageComponent,`,
+                `                        TemplateComponent,`,
+                `                        doUseDefaultCss,`,
+                `                        classes,`,
+                ...(themeType === 'login'
+                    ? [
+                          `                        UserProfileFormFieldsComponent,`,
+                          `                        doMakeUserConfirmPassword,`
+                      ]
+                    : []),
+                `                    },`,
+                `                ] = await Promise.all([`,
+                `                    import('@keycloakify/angular/login/providers/keycloakify-angular'),`,
+                `                    import('./${themeType}/i18n'),`,
+                `                    import('./${themeType}/KcPage').then(({ getKcPage }) => getKcPage(kcContext.pageId)),`,
+                `                ] as const);`,
+                ``,
+                `                const appRef = await bootstrapApplication({`,
+                `                    KcRootComponent: TemplateComponent,`,
+                `                    kcProvider: provideKeycloakifyAngular({`,
+                `                        kcContext,`,
+                `                        classes,`,
+                `                        getI18n,`,
+                `                        doUseDefaultCss,`,
+                ...(themeType === 'login'
+                    ? [`                        doMakeUserConfirmPassword,`]
+                    : []),
+                `                    })`,
+                `                });`,
+                ``,
+                `                appRef.components.forEach(componentRef => {`,
+                `                    if ("page" in componentRef.instance) {`,
+                `                        componentRef.setInput("page", PageComponent);`,
+                `                    }`,
+                ...(themeType === 'login'
+                    ? [
+                          `                    if ("userProfileFormFields" in componentRef.instance) {`,
+                          `                        componentRef.setInput(`,
+                          `                            "userProfileFormFields",`,
+                          `                            UserProfileFormFieldsComponent`,
+                          `                        );`,
+                          `                    }`
+                      ]
+                    : []),
+                `                });`,
+                `            }`,
+                `            break;`
+            ])
+            .flat(),
+        `    }`,
+        `}`,
+        ``
+    ].join('\n');
+
+    const hash = crypto.createHash('sha256').update(newContent).digest('hex');
+
+    skip_if_no_changes: {
+        if (!fs.existsSync(filePath)) {
+            break skip_if_no_changes;
+        }
+
+        const currentContent = fs.readFileSync(filePath).toString('utf8');
+
+        if (!currentContent.includes(hash)) {
+            break skip_if_no_changes;
+        }
 
-    if (currentContent !== undefined && currentContent.equals(newContent)) {
         return;
     }
 
-    fs.writeFileSync(filePath, newContent);
+    fs.writeFileSync(
+        filePath,
+        Buffer.from(
+            [
+                `// This file is auto-generated by keycloakify. Do not edit it manually.`,
+                `// Hash: ${hash}`,
+                ``,
+                newContent
+            ].join('\n'),
+            'utf8'
+        )
+    );
 
     runFormat({ packageJsonFilePath: buildContext.packageJsonFilePath });
 }