@reveldigital/player-client 1.0.15 → 2.0.2

package/lib/safe-style.pipe.d.ts

@@ -1,24 +1,24 @@
-import { PipeTransform } from '@angular/core';
-import { DomSanitizer } from '@angular/platform-browser';
-import * as i0 from "@angular/core";
-/**
- * The safe style pipe is used when custom styles are defined for a gadget and must be applied to an Angular
- * component. This pipe will ensure the style can be appied safely by utilizing the DomSanitizer.
- *
- * ```html
- * <h2 [style]="style | safeStyle">Sample Pref: {{ prefs.getString('myStringPref') }}</h2>
- * ```
- */
-export declare class SafeStylePipe implements PipeTransform {
-    private sanitized;
-    constructor(sanitized: DomSanitizer);
-    transform(value: any): unknown;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SafeStylePipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<SafeStylePipe, "safeStyle">;
-}
-export declare class NgSafeStylePipeModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgSafeStylePipeModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgSafeStylePipeModule, [typeof SafeStylePipe], never, [typeof SafeStylePipe]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgSafeStylePipeModule>;
-}
+import { PipeTransform } from '@angular/core';
+import { DomSanitizer } from '@angular/platform-browser';
+import * as i0 from "@angular/core";
+/**
+ * The safe style pipe is used when custom styles are defined for a gadget and must be applied to an Angular
+ * component. This pipe will ensure the style can be appied safely by utilizing the DomSanitizer.
+ *
+ * ```html
+ * <h2 [style]="style | safeStyle">Sample Pref: {{ prefs.getString('myStringPref') }}</h2>
+ * ```
+ */
+export declare class SafeStylePipe implements PipeTransform {
+    private sanitized;
+    constructor(sanitized: DomSanitizer);
+    transform(value: any): unknown;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SafeStylePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SafeStylePipe, "safeStyle", true>;
+}
+export declare class NgSafeStylePipeModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgSafeStylePipeModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgSafeStylePipeModule, never, [typeof SafeStylePipe], [typeof SafeStylePipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgSafeStylePipeModule>;
+}
 //# sourceMappingURL=safe-style.pipe.d.ts.map

package/lib/safe-style.pipe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-style.pipe.d.ts","sourceRoot":"","sources":["../../../../projects/reveldigital/player-client/src/lib/safe-style.pipe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,aAAa,EAAY,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;;AAEzD;;;;;;;GAOG;AACH,qBAGa,aAAc,YAAW,aAAa;IACnC,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,YAAY;IAE3C,SAAS,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;yCAHrB,aAAa;uCAAb,aAAa;CAMzB;AAED,qBAIa,qBAAqB;yCAArB,qBAAqB;0CAArB,qBAAqB,UAZrB,aAAa,kBAAb,aAAa;0CAYb,qBAAqB;CAAI"}
+{"version":3,"file":"safe-style.pipe.d.ts","sourceRoot":"","sources":["../../../../projects/reveldigital/player-client/src/lib/safe-style.pipe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,aAAa,EAAY,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;;AAEzD;;;;;;;GAOG;AACH,qBAIa,aAAc,YAAW,aAAa;IACnC,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,YAAY;IAE3C,SAAS,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;yCAHrB,aAAa;uCAAb,aAAa;CAMzB;AAED,qBAIa,qBAAqB;yCAArB,qBAAqB;0CAArB,qBAAqB,iBAZrB,aAAa,WAAb,aAAa;0CAYb,qBAAqB;CAAI"}

package/lib/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "1.0.15";
+export declare const version = "2.0.2";
 //# sourceMappingURL=version.d.ts.map

package/lib/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../../projects/reveldigital/player-client/src/lib/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,WAAW,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../../projects/reveldigital/player-client/src/lib/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,UAAU,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@reveldigital/player-client",
-  "version": "1.0.15",
-  "description": "Helper library for interfacing Angular apps with the Revel Digital player",
+  "version": "2.0.2",
+  "description": "Helper library for interfacing Angular apps with the Revel Digital gadget framework.",
   "schematics": "./schematics/collection.json",
   "ng-add": {
     "save": "dependencies"
@@ -18,10 +18,10 @@
   "author": {
     "name": "Mike Tinnes"
   },
-  "license": "",
+  "license": "MIT",
   "peerDependencies": {
-    "@angular/common": ">= 13.0.0",
-    "@angular/core": ">= 13.0.0",
+    "@angular/common": ">= 16.0.0",
+    "@angular/core": ">= 16.0.0",
     "@reveldigital/gadget-types": "1.0.0",
     "webfontloader": "1.6.28",
     "js-yaml": "^4.1.0"
@@ -29,24 +29,18 @@
   "dependencies": {
     "tslib": "^2.4.1"
   },
-  "module": "fesm2015/reveldigital-player-client.mjs",
-  "es2020": "fesm2020/reveldigital-player-client.mjs",
-  "esm2020": "esm2020/reveldigital-player-client.mjs",
-  "fesm2020": "fesm2020/reveldigital-player-client.mjs",
-  "fesm2015": "fesm2015/reveldigital-player-client.mjs",
-  "typings": "reveldigital-player-client.d.ts",
+  "module": "fesm2022/reveldigital-player-client.mjs",
+  "typings": "index.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
     },
     ".": {
-      "types": "./reveldigital-player-client.d.ts",
-      "esm2020": "./esm2020/reveldigital-player-client.mjs",
-      "es2020": "./fesm2020/reveldigital-player-client.mjs",
-      "es2015": "./fesm2015/reveldigital-player-client.mjs",
-      "node": "./fesm2015/reveldigital-player-client.mjs",
-      "default": "./fesm2020/reveldigital-player-client.mjs"
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/reveldigital-player-client.mjs",
+      "esm": "./esm2022/reveldigital-player-client.mjs",
+      "default": "./fesm2022/reveldigital-player-client.mjs"
     }
   },
   "sideEffects": false
-}
+}

package/public-api.d.ts

@@ -1,4 +1,4 @@
-export * from './lib/player-client.service';
-export * from './lib/player-client.module';
-export * from './lib/safe-style.pipe';
+export * from './lib/player-client.service';
+export * from './lib/player-client.module';
+export * from './lib/safe-style.pipe';
 //# sourceMappingURL=public-api.d.ts.map

package/schematics/collection.json

@@ -1,16 +1,16 @@
-{
-  "$schema": "../../../../node_modules/@angular-devkit/schematics/collection-schema.json",
-  "schematics": {
-    "ng-add": {
-      "description": "Add the Revel Digital client library to your project.",
-      "factory": "./ng-add/index#dependencies",
-      "schema": "./ng-add/schema.json"
-    },
-    "after-dependencies": {
-      "description": "Add the Revel Digital client library to your project.",
-      "factory": "./ng-add/index#ngAdd",
-      "schema": "./ng-add/schema.json",
-      "private": true
-    }
-  }
+{
+  "$schema": "../../../../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Add the Revel Digital client library to your project.",
+      "factory": "./ng-add/index#dependencies",
+      "schema": "./ng-add/schema.json"
+    },
+    "after-dependencies": {
+      "description": "Add the Revel Digital client library to your project.",
+      "factory": "./ng-add/index#ngAdd",
+      "schema": "./ng-add/schema.json",
+      "private": true
+    }
+  }
 }

package/schematics/ng-add/assets/gadget.yaml

@@ -1,54 +1,54 @@
-title: My Gadget
-title_url: https://mysupporturl.org
-description: Describe the purpose of your gadget here
-author: My Organization
-background: transparent
-
-requirements:
-  - reveldigital
-  - offline
-  - webfont
-
-locales:
-  - messages: https://reveldigital.github.io/reveldigital-gadgets/ALL_ALL.xml
-
-  - lang: ru
-    messages: https://reveldigital.github.io/reveldigital-gadgets/ALL_ALL.xml
-
-prefs:
-  - name: myStringPref
-    display_name: Sample string preference
-    datatype: string
-    default_value: test string
-    required: true
-
-  - name: myBoolPref
-    display_name: Sample boolean preference
-    datatype: bool
-    default_value: true
-    required: true
-    depends:
-      - name: myEnumPref
-        any_of:
-          - values:
-            - fast
-
-  - name: myStylePref
-    display_name: Sample style preference
-    datatype: style
-    default_value: font-family:Verdana;color:rgb(255, 255, 255);font-size:18px;
-    required: true
-
-  - name: myEnumPref
-    display_name: Sample enum preference
-    datatype: enum
-    default_value: fast
-    required: true
-    multiple: false
-    options:
-      - value: fastest
-        display_value: Fastest
-      - value: fast
-        display_value: Fast
-      - value: medium
-        display_value: Medium
+title: My Gadget
+title_url: https://mysupporturl.org
+description: Describe the purpose of your gadget here
+author: My Organization
+background: transparent
+
+requirements:
+  - reveldigital
+  - offline
+  - webfont
+
+locales:
+  - messages: https://reveldigital.github.io/reveldigital-gadgets/ALL_ALL.xml
+
+  - lang: ru
+    messages: https://reveldigital.github.io/reveldigital-gadgets/ALL_ALL.xml
+
+prefs:
+  - name: myStringPref
+    display_name: Sample string preference
+    datatype: string
+    default_value: test string
+    required: true
+
+  - name: myBoolPref
+    display_name: Sample boolean preference
+    datatype: bool
+    default_value: true
+    required: true
+    depends:
+      - name: myEnumPref
+        any_of:
+          - values:
+            - fast
+
+  - name: myStylePref
+    display_name: Sample style preference
+    datatype: style
+    default_value: font-family:Verdana;color:rgb(255, 255, 255);font-size:18px;
+    required: true
+
+  - name: myEnumPref
+    display_name: Sample enum preference
+    datatype: enum
+    default_value: fast
+    required: true
+    multiple: false
+    options:
+      - value: fastest
+        display_value: Fastest
+      - value: fast
+        display_value: Fast
+      - value: medium
+        display_value: Medium

package/schematics/ng-add/index.d.ts

@@ -1,4 +1,18 @@
-import { Rule } from '@angular-devkit/schematics';
-import { Schema as MyServiceSchema } from './schema';
-export declare function ngAdd(options: MyServiceSchema): Rule;
-export declare function dependencies(options: any): Rule;
+import { Rule } from '@angular-devkit/schematics';
+import { Schema as MyServiceSchema } from './schema';
+/**
+ * Main schematic rule for adding Revel Digital Player Client to an Angular project.
+ *
+ * This schematic performs the following operations:
+ * - Validates the target project is an Angular application
+ * - Adds required dependencies to package.json
+ * - Updates the app module to import PlayerClientModule
+ * - Adds utility files and assets
+ * - Configures build scripts for gadget development
+ * - Optionally sets up GitHub Pages deployment
+ */
+export declare function ngAdd(options: MyServiceSchema): Rule;
+/**
+ * Adds dependencies required for the schematic.
+ */
+export declare function dependencies(options: any): Rule;