@ama-styling/devkit 14.1.0-prerelease.2 → 14.1.0-prerelease.4

package/index.d.ts

@@ -0,0 +1,164 @@
+import { ItemIdentifier, DevtoolsCommonOptions, OtterMessageContent, MessageDataTypes, ConnectContentMessage, RequestMessagesContentMessage } from '@o3r/core';
+import * as i0 from '@angular/core';
+import { ModuleWithProviders, InjectionToken } from '@angular/core';
+
+/** Style Metadata map */
+interface CssMetadata {
+    /** Variables' dictionary */
+    variables: {
+        [name: string]: CssVariable;
+    };
+}
+/** Metadata information added in the design token extension for Metadata extraction */
+interface DesignTokenMetadata {
+    /** List of tags */
+    tags?: string[];
+    /** Description of the variable */
+    label?: string;
+    /** Name of a group of variables */
+    category?: string;
+    /** Component reference if the variable is linked to one */
+    component?: ItemIdentifier;
+}
+/** CSS Variable possible types */
+type CssVariableType = 'string' | 'color';
+/** Metadata for a CSS Variable */
+interface CssVariable {
+    /** Name of the variable */
+    name: string;
+    /** Default value of the variable */
+    defaultValue: string;
+    /** References of the variable */
+    references?: CssVariable[];
+    /** Tags of the variable */
+    tags?: string[];
+    /** Description of the variable */
+    description?: string;
+    /** Description of the variable */
+    label?: string;
+    /** Type of the variable */
+    type?: CssVariableType;
+    /** Name of a group of variables */
+    category?: string;
+    /** component reference if the variable is linked to one */
+    component?: ItemIdentifier;
+}
+/**
+ * Styling devtools service options
+ */
+interface StylingDevtoolsServiceOptions extends DevtoolsCommonOptions {
+    /**
+     * Path to retrieve the styling metadata file
+     */
+    stylingMetadataPath: string;
+}
+/** Update styling variables */
+interface UpdateStylingVariablesContentMessage extends OtterMessageContent<'updateStylingVariables'> {
+    /**
+     * Dictionary of variable value to update
+     * indexed by the variable name
+     */
+    variables: Record<string, string>;
+}
+/** Reset styling variables override */
+interface ResetStylingVariablesContentMessage extends OtterMessageContent<'resetStylingVariables'> {
+}
+/** Styling variable */
+type StylingVariable = CssVariable & {
+    runtimeValue?: string;
+};
+/** Get styling variables */
+interface GetStylingVariableContentMessage extends OtterMessageContent<'getStylingVariable'> {
+    /** List of styling variables */
+    variables: StylingVariable[];
+}
+/**
+ * List of styling message contents
+ */
+type StylingMessageContents = UpdateStylingVariablesContentMessage | ResetStylingVariablesContentMessage | GetStylingVariableContentMessage;
+/** List of possible DataTypes for Styling messages */
+type StylingMessageDataTypes = MessageDataTypes<StylingMessageContents>;
+/** List of all messages for Styling purposes */
+type AvailableStylingMessageContents = StylingMessageContents | ConnectContentMessage | RequestMessagesContentMessage<StylingMessageDataTypes>;
+/** Tag to identify theme variable */
+declare const THEME_TAG_NAME = "theme";
+/** Tag to identify palette variable */
+declare const PALETTE_TAG_NAME = "palette";
+
+/**
+ * Styling devtools service
+ */
+declare class OtterStylingDevtools {
+    private readonly document;
+    /**
+     * Retrieve styling metadata
+     * @param stylingMetadataPath
+     */
+    getStylingMetadata(stylingMetadataPath: string): Promise<CssMetadata>;
+    /**
+     * Update styling variables
+     * @param variables
+     */
+    updateVariables(variables: Record<string, string>): void;
+    /**
+     * Reset styling variables override
+     */
+    resetStylingVariables(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OtterStylingDevtools, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<OtterStylingDevtools>;
+}
+
+/**
+ * Service to handle communication between application and chrome extension for styling
+ */
+declare class StylingDevtoolsMessageService {
+    private readonly logger;
+    private readonly stylingDevTools;
+    private readonly options;
+    private readonly sendMessage;
+    private readonly destroyRef;
+    constructor();
+    private sendMetadata;
+    /**
+     * Function to trigger a re-send a requested messages to the Otter Chrome DevTools extension
+     * @param only restricted list of messages to re-send
+     */
+    private handleReEmitRequest;
+    /**
+     * Function to handle the incoming messages from Otter Chrome DevTools extension
+     * @param message Message coming from the Otter Chrome DevTools extension
+     */
+    private handleEvents;
+    /**
+     * Function to connect the plugin to the Otter Chrome DevTools extension
+     */
+    private connectPlugin;
+    /** @inheritDoc */
+    activate(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<StylingDevtoolsMessageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<StylingDevtoolsMessageService>;
+}
+
+declare class StylingDevtoolsModule {
+    /**
+     * Initialize Otter Devtools
+     * @param options
+     */
+    static instrument(options: Partial<StylingDevtoolsServiceOptions>): ModuleWithProviders<StylingDevtoolsModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<StylingDevtoolsModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<StylingDevtoolsModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<StylingDevtoolsModule>;
+}
+
+/**
+ * Default value for styling devtools
+ */
+declare const OTTER_STYLING_DEVTOOLS_DEFAULT_OPTIONS: Readonly<StylingDevtoolsServiceOptions>;
+/**
+ * Token for styling devtools
+ */
+declare const OTTER_STYLING_DEVTOOLS_OPTIONS: InjectionToken<StylingDevtoolsServiceOptions>;
+
+export { OTTER_STYLING_DEVTOOLS_DEFAULT_OPTIONS, OTTER_STYLING_DEVTOOLS_OPTIONS, OtterStylingDevtools, PALETTE_TAG_NAME, StylingDevtoolsMessageService, StylingDevtoolsModule, THEME_TAG_NAME };
+export type { AvailableStylingMessageContents, CssMetadata, CssVariable, CssVariableType, DesignTokenMetadata, GetStylingVariableContentMessage, ResetStylingVariablesContentMessage, StylingDevtoolsServiceOptions, StylingMessageDataTypes, StylingVariable, UpdateStylingVariablesContentMessage };
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":["../src/core/styling-devkit-interface.ts","../src/core/styling-devtools.ts","../src/core/styling-devtools-message-service.ts","../src/core/styling-devtools-module.ts","../src/core/styling-devtools-token.ts"],"sourcesContent":[null,null,null,null,null],"names":[],"mappings":";;;;AASA;;;AAGE;AACE,wBAAA,WAAA;;AAEH;AAED;;;AAGE;;;;;;;AAOD;AAED;;AAGA;;;;;;;AAOE,iBAAA,WAAA;;AAEA;;;;;;;;;;;AAWD;AAED;;AAEG;AACG,UAAA,6BAAA,SAAA,qBAAA;AACJ;;AAEG;;AAEJ;AAED;;AAEE;;;AAGG;AACH,eAAA,MAAA;AACD;AAED;;AAC4G;AAE5G;AACM,KAAA,eAAA,GAAA,WAAA;;;AAEN;;;;AAIC;AAED;;AAEG;AACH,KAAA,sBAAA,GAAA,oCAAA,GAAA,mCAAA,GAAA,gCAAA;AAIA;;AAGA;AACM,KAAA,+BAAA,GAAA,sBAAA,GAAA,qBAAA,GAAA,6BAAA,CAAA,uBAAA;AAIN;AACA,cAAA,cAAA;AAEA;AACA,cAAA,gBAAA;;AC/FA;;AAEG;AACH,cAAA,oBAAA;AAEE;AAEA;;;AAGG;;AAKH;;;AAGG;;AAKH;;AAEG;;;;AAWJ;;ACkCD;;AAEG;AACH,cAAA,6BAAA;AAEE;AACA;AACA;AAEA;AACA;;;AAsBA;;;AAGG;AACH;AAMA;;;AAGG;AACH;AA0BA;;AAEG;AACH;;;;;AAWD;;ACnJD,cAAA,qBAAA;AAQE;;;AAGG;;;;;AAWJ;;ACjCD;;AAEG;AACH,cAAA,sCAAA,EAAA,QAAA,CAAA,6BAAA;AAKA;;AAEG;AACH,cAAA,8BAAA,EAAA,cAAA,CAAA,6BAAA;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-styling/devkit",
-  "version": "14.1.0-prerelease.2",
+  "version": "14.1.0-prerelease.4",
   "publishConfig": {
     "access": "public"
   },
@@ -18,10 +18,10 @@
     "@angular-devkit/schematics": "~21.0.2",
     "@angular/common": "~21.0.3",
     "@angular/core": "~21.0.3",
-    "@o3r/core": "~14.1.0-prerelease.2",
-    "@o3r/logger": "~14.1.0-prerelease.2",
-    "@o3r/schematics": "~14.1.0-prerelease.2",
-    "@o3r/testing": "~14.1.0-prerelease.2",
+    "@o3r/core": "~14.1.0-prerelease.4",
+    "@o3r/logger": "~14.1.0-prerelease.4",
+    "@o3r/schematics": "~14.1.0-prerelease.4",
+    "@o3r/testing": "~14.1.0-prerelease.4",
     "@schematics/angular": "~21.0.2",
     "rxjs": "^7.8.1",
     "type-fest": "^5.3.1",
@@ -48,7 +48,7 @@
     }
   },
   "dependencies": {
-    "@o3r/schematics": "~14.1.0-prerelease.2",
+    "@o3r/schematics": "~14.1.0-prerelease.4",
     "tslib": "^2.6.2"
   },
   "engines": {

package/schematics/ng-add/helpers/devtools-registration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devtools-registration.js","sourceRoot":"","sources":["../../../../schematics/ng-add/helpers/devtools-registration.ts"],"names":[],"mappings":";;;AAAA,qCAEiB;AACjB,kCAAkC;AAClC,gDAEyB;AAKzB,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AACpD,MAAM,oBAAoB,GAAG,+BAA+B,CAAC;AAC7D,MAAM,YAAY,GAAW,IAAI,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAE5I;;;GAGG;AACI,MAAM,gBAAgB,GAAG,CAAC,OAA8B,EAAE,EAAE;IACjE,OAAO,IAAA,0CAA6B,EAAC;QACnC,UAAU,EAAE,mBAAmB;QAC/B,WAAW,EAAE,YAAY;QACzB,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC,CAAC;AACL,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B"}

package/schematics/ng-add/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schematics/ng-add/index.ts"],"names":[],"mappings":";;;AAAA,yCAEmB;AACnB,2DAGoC;AACpC,gDAGyB;AACzB,2EAEyC;AAKzC,MAAM,eAAe,GAAG,IAAA,mBAAO,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;AAEvE;;;GAGG;AACH,SAAS,OAAO,CAAC,OAA8B;IAC7C,kBAAkB;IAClB,OAAO,IAAA,kBAAK,EAAC;QACX,IAAA,kCAAqB,EAAC,OAAO,EAAE,eAAe,EAAE,EAAE,CAAC;QACnD,IAAA,wCAAgB,EAAC,OAAO,CAAC;KAC1B,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACI,MAAM,KAAK,GAAG,CAAC,OAA8B,EAAE,EAAE,CAAC,IAAA,iCAAoB,EAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;AAAnF,QAAA,KAAK,SAA8E"}

package/schematics/ng-add/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../schematics/ng-add/schema.ts"],"names":[],"mappings":""}