webext-schema 5.1.2 → 5.1.4

package/index.js

@@ -7,9 +7,9 @@
  */
 
 /* api */
+import process from 'node:process';
 import { logErr, throwErr } from './modules/common.js';
 import { parseCommand } from './modules/update.js';
-import process from 'node:process';
 export { Schema } from './modules/schema.js';
 
 /* process */

package/modules/file-util.js

@@ -3,10 +3,10 @@
  */
 
 /* api */
-import { fileURLToPath } from 'node:url';
-import { getType, isString } from './common.js';
 import fs, { promises as fsPromise } from 'node:fs';
 import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { getType, isString } from './common.js';
 import { IS_WIN } from './constant.js';
 
 /* constants */

package/modules/schema.js

@@ -3,16 +3,19 @@
  */
 
 /* api */
-import { CHAR } from './constant.js';
-import { convertUriToFilePath } from './file-util.js';
-import { getType, isObjectNotEmpty, isString } from './common.js';
-import camelize from 'camelize';
-import decamelize from 'decamelize';
 import fs from 'node:fs';
 import path from 'node:path';
+import camelize from 'camelize';
+import decamelize from 'decamelize';
 import sinon from 'sinon';
+import { getType, isObjectNotEmpty, isString } from './common.js';
+import { convertUriToFilePath } from './file-util.js';
+import { CHAR } from './constant.js';
 
 export class Schema {
+  /* private */
+  #channel;
+
   /**
    * construct
    *
@@ -24,7 +27,7 @@ export class Schema {
    */
   constructor(...args) {
     const [arg1, arg2] = args;
-    this._channel =
+    this.#channel =
       isString(arg1) && /(?:(?:centra|mai)l|beta|esr|release)/.test(arg1)
         ? arg1
         : 'beta';
@@ -40,12 +43,12 @@ export class Schema {
 
   /* getter / setter */
   get channel() {
-    return this._channel;
+    return this.#channel;
   }
 
   set channel(ch) {
     if (isString(ch) && /(?:(?:centra|mai)l|beta|esr|release)/.test(ch)) {
-      this._channel = ch;
+      this.#channel = ch;
     }
   }
 
@@ -264,9 +267,9 @@ export class Schema {
    * @returns {object} - schema
    */
   _parseSchemaContent() {
-    const fileName = this._channel === 'mail' ? 'mailext.json' : 'webext.json';
+    const fileName = this.#channel === 'mail' ? 'mailext.json' : 'webext.json';
     const dirName = path.dirname(convertUriToFilePath(import.meta.url));
-    const file = path.join(dirName, '../', 'schemas', this._channel, fileName);
+    const file = path.join(dirName, '../', 'schemas', this.#channel, fileName);
     const content = fs.readFileSync(file, {
       encoding: CHAR,
       flag: 'r'

package/modules/update.js

@@ -3,13 +3,13 @@
  */
 
 /* api */
-import { CHAR, INDENT } from './constant.js';
-import JSON5 from 'json5';
-import { createFile } from './file-util.js';
-import { getType, isString } from './common.js';
-import { program as commander } from 'commander';
 import path from 'node:path';
 import process from 'node:process';
+import JSON5 from 'json5';
+import { program as commander } from 'commander';
+import { getType, isString } from './common.js';
+import { createFile } from './file-util.js';
+import { CHAR, INDENT } from './constant.js';
 
 /* constants */
 const DIR_CWD = process.cwd();

package/package.json

@@ -11,7 +11,10 @@
   },
   "type": "module",
   "main": "index.js",
+  "types": "types/index.d.ts",
   "dependencies": {
+    "@types/node": "^18.14.0",
+    "@types/sinon": "^10.0.13",
     "camelize": "^1.0.1",
     "commander": "^10.0.0",
     "decamelize": "^6.0.0",
@@ -30,9 +33,11 @@
     "eslint-plugin-unicorn": "^45.0.2",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
+    "typescript": "^4.9.5",
     "undici": "^5.19.1"
   },
   "scripts": {
+    "build": "npm run tsc && npm run lint && npm run test",
     "lint": "eslint --fix .",
     "start": "node index",
     "test": "npm run test-central",
@@ -41,6 +46,7 @@
     "test-esr": "c8 mocha --require=test/mocha/setup.js --channel=esr --exit test/*.test.js",
     "test-release": "c8 mocha --require=test/mocha/setup.js --channel=release --exit test/*.test.js",
     "test_all": "npm-run-all -s test-*",
+    "tsc": "node -e \"fs.rmSync('types',{recursive:true,force:true})\" && npx tsc",
     "update": "node index update -i",
     "update-beta": "node index update --channel=beta -i",
     "update-central": "node index update --channel=central -i",
@@ -48,5 +54,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.1.2"
+  "version": "5.1.4"
 }

package/schemas/central/webext.json

@@ -9721,13 +9721,24 @@
             }
           ]
         },
+        {
+          "$extend": "OptionalPermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "declarativeNetRequestFeedback"
+              ],
+              "min_manifest_version": 3
+            }
+          ]
+        },
         {
           "$extend": "PermissionNoPrompt",
           "choices": [
             {
               "type": "string",
               "enum": [
-                "declarativeNetRequestFeedback",
                 "declarativeNetRequestWithHostAccess"
               ],
               "min_manifest_version": 3
@@ -10426,6 +10437,11 @@
         }
       ],
       "properties": {
+        "DYNAMIC_RULESET_ID": {
+          "type": "string",
+          "value": "_dynamic",
+          "description": "Ruleset ID for the dynamic rules added by the extension."
+        },
         "GUARANTEED_MINIMUM_STATIC_RULES": {
           "type": "number",
           "description": "The minimum number of static rules guaranteed to an extension across its enabled static rulesets. Any rules above this limit will count towards the global static rule limit."
@@ -10441,6 +10457,11 @@
         "MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES": {
           "type": "number",
           "description": "The maximum number of dynamic and session rules an extension can add. NOTE: in the Firefox we are enforcing this limit to the session and dynamic rules count separately, instead of enforcing it to the rules count for both combined as the Chrome implementation does."
+        },
+        "SESSION_RULESET_ID": {
+          "type": "string",
+          "value": "_session",
+          "description": "Ruleset ID for the session-scoped rules added by the extension."
         }
       }
     }
@@ -12405,7 +12426,7 @@
             "mainthreadio",
             "fileio",
             "fileioall",
-            "noiostacks",
+            "nomarkerstacks",
             "screenshots",
             "seqstyle",
             "stackwalk",
@@ -13562,6 +13583,14 @@
                         "$ref": "ExtensionURL"
                       }
                     },
+                    "type": {
+                      "optional": true,
+                      "type": "string",
+                      "enum": [
+                        "module",
+                        "classic"
+                      ]
+                    },
                     "persistent": {
                       "optional": true,
                       "type": "boolean",
@@ -20138,6 +20167,26 @@
               },
               "description": "list of reasons that cause the request to be considered weak, if state is \"weak\"",
               "optional": true
+            },
+            "usedEch": {
+              "type": "boolean",
+              "description": "True if the TLS connection used Encrypted Client Hello.",
+              "optional": true
+            },
+            "usedDelegatedCredentials": {
+              "type": "boolean",
+              "description": "True if the TLS connection used Delegated Credentials.",
+              "optional": true
+            },
+            "usedOcsp": {
+              "type": "boolean",
+              "description": "True if the TLS connection made OCSP requests.",
+              "optional": true
+            },
+            "usedPrivateDns": {
+              "type": "boolean",
+              "description": "True if the TLS connection used a privacy-preserving DNS transport like DNS-over-HTTPS.",
+              "optional": true
             }
           }
         },

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "include": ["index.js"],
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "declarationDir": "types",
+    "emitDeclarationOnly": true,
+    "newLine": "LF",
+    "removeComments": true
+  }
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export { Schema } from "./modules/schema.js";

package/types/modules/common.d.ts

@@ -0,0 +1,7 @@
+export function throwErr(e: object): never;
+export function logErr(e: object): boolean;
+export function logWarn(msg: any): boolean;
+export function logMsg(msg: any): any;
+export function getType(o: any): string;
+export function isObjectNotEmpty(o: any): boolean;
+export function isString(o: any): boolean;

package/types/modules/constant.d.ts

@@ -0,0 +1,3 @@
+export const CHAR: "utf8";
+export const INDENT: 2;
+export const IS_WIN: boolean;

package/types/modules/file-util.d.ts

@@ -0,0 +1,21 @@
+export function convertUriToFilePath(uri: string): string | null;
+export function getAbsPath(file: string): string | null;
+export function getStat(file: string): object;
+export function isDir(dir: string): boolean;
+export function isSubDir(dir: string, baseDir: string): boolean;
+export function isFile(file: string): boolean;
+export function isExecutable(file: string, mask?: number): boolean;
+export function getFileTimestamp(file: string): number;
+export function getFileNameFromFilePath(file: string, subst?: string): string;
+export function removeDir(dir: string, baseDir: string): void;
+export function removeDirectory(dir: string, baseDir: string): void;
+export function createDirectory(dir: string, mode?: number): string;
+export function createFile(file: string, value: string | Buffer | Uint8Array, opt?: {
+    encoding?: string;
+    flag?: string;
+    mode?: number | string;
+}): string;
+export function readFile(file: string, opt?: {
+    encoding?: string;
+    flag?: string;
+}): string | Buffer;

package/types/modules/schema.d.ts

@@ -0,0 +1,26 @@
+export class Schema {
+    constructor(...args?: (string | object)[]);
+    _sandbox: sinon.SinonSandbox;
+    _importMap: Map<any, any>;
+    _refMap: Map<any, any>;
+    _browser: {
+        _sandbox: sinon.SinonSandbox;
+    };
+    _schema: any;
+    set channel(arg: any);
+    get channel(): any;
+    _getTargetFromNamespace(key: string): object;
+    _assignImportMap(): void;
+    _assignRefMap(): void;
+    _mockEvents(target: object, events: any[]): object;
+    _mockFunctions(target: object, funcs: any[]): object;
+    _mockProperties(target: object, props: object, namespace: string): object;
+    _mockTypes(target: object, types: any[], namespace: string): object;
+    _parseSchemaContent(): object;
+    get(name: string): any[];
+    getAll(): object;
+    list(): any[];
+    mock(): object;
+    #private;
+}
+import sinon from "sinon";

package/types/modules/update.d.ts

@@ -0,0 +1,14 @@
+export const ESR_VER: 102;
+export function fetchText(url: string): string;
+export function getChannelUrl(channel: string): string;
+export function getSchemaData(file: string, baseUrl: string): object;
+export function getFileList(baseUrl: string): any[];
+export function getAllSchemaData(baseUrl: string): Promise<any[]>;
+export function getListedSchemaData(baseUrl: string, arr: any[]): Promise<any[]>;
+export function getMailExtSchemaData(baseUrl: string): Promise<any[]>;
+export function createUnifiedSchema(channel: string): object;
+export function saveSchemaFile(channel: string, info: boolean): string;
+export function updateSchemas(cmdOpts?: object): void;
+export function parseCommand(args: any[]): void;
+export { commander };
+import { program as commander } from "commander";