eslint-plugin-cvsdk-rules 14.0.2-protected → 14.1.0-alpha.2-protected

package/build/index.d.ts

@@ -3,6 +3,8 @@ declare const plugin: {
         'prefer-no-lodash-cloneDeep': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenCloneDeepUsage", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
         'prefer-self-over-window': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenWindowAccess", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
         'prefer-txml-over-domparser': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenDomParserUsage", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+        'no-device-type-imports': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenDeviceTypeUsage" | "forbiddenDeviceTypeUtilUsage", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+        'prefer-private-exposables': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"preferPrivateExposable", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
     };
 };
 export { plugin };

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,QAAA,MAAM,MAAM;;;;;;CAEX,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,QAAA,MAAM,MAAM;;;;;;;;CAEX,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/build/index.js

@@ -1,10 +1,14 @@
 import { rule as preferSelfOverWindow } from './rules/prefer-self-over-window.js';
 import { rule as preferTxmlOverDomParser } from './rules/prefer-txml-over-domparser.js';
 import { rule as preferNoLodashCloneDeep } from './rules/prefer-no-lodash-clone-deep.js';
+import { rule as noDeviceTypeImports } from './rules/no-device-type-imports.js';
+import { rule as preferPrivateExposables } from './rules/prefer-private-exposables.js';
 var rules = {
     'prefer-no-lodash-cloneDeep': preferNoLodashCloneDeep,
     'prefer-self-over-window': preferSelfOverWindow,
     'prefer-txml-over-domparser': preferTxmlOverDomParser,
+    'no-device-type-imports': noDeviceTypeImports,
+    'prefer-private-exposables': preferPrivateExposables,
 };
 var plugin = {
     rules: rules,

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAClF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAEzF,IAAM,KAAK,GAAG;IACV,4BAA4B,EAAE,uBAAuB;IACrD,yBAAyB,EAAE,oBAAoB;IAC/C,4BAA4B,EAAE,uBAAuB;CACxD,CAAC;AAEF,IAAM,MAAM,GAAG;IACX,KAAK,OAAA;CACR,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAClF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AACzF,OAAO,EAAE,IAAI,IAAI,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAEvF,IAAM,KAAK,GAAG;IACV,4BAA4B,EAAE,uBAAuB;IACrD,yBAAyB,EAAE,oBAAoB;IAC/C,4BAA4B,EAAE,uBAAuB;IACrD,wBAAwB,EAAE,mBAAmB;IAC7C,2BAA2B,EAAE,uBAAuB;CACvD,CAAC;AAEF,IAAM,MAAM,GAAG;IACX,KAAK,OAAA;CACR,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/build/rules/no-device-type-imports.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rule: ESLintUtils.RuleModule<"forbiddenDeviceTypeUsage" | "forbiddenDeviceTypeUtilUsage", never[], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=no-device-type-imports.d.ts.map

package/build/rules/no-device-type-imports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-device-type-imports.d.ts","sourceRoot":"","sources":["../../src/rules/no-device-type-imports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAItE,eAAO,MAAM,IAAI,iIAoCf,CAAC"}

package/build/rules/no-device-type-imports.js

@@ -0,0 +1,36 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) { return name; });
+export var rule = createRule({
+    create: function (context) {
+        return {
+            "Program:has(ImportDeclaration[source.value='@sky-uk-ott/client-lib-js-device'] > ImportSpecifier[imported.name=DeviceType])": function (node) {
+                context.report({
+                    node: node,
+                    messageId: 'forbiddenDeviceTypeUsage',
+                });
+            },
+            // Note the unicode character here is required to match a forward slash in the import path
+            // See https://eslint.org/docs/latest/extend/selectors#known-issues
+            'Program:has(ImportDeclaration[source.value=/.*\\u002Fdevice-type/])': function (node) {
+                context.report({
+                    node: node,
+                    messageId: 'forbiddenDeviceTypeUtilUsage',
+                });
+            },
+        };
+    },
+    name: 'no-device-type-imports',
+    meta: {
+        docs: {
+            description: 'Detect DeviceType usage in the CVSDK',
+        },
+        messages: {
+            forbiddenDeviceTypeUsage: 'This portion of the CVSDK is device agnostic. Please do not directly use DeviceType for device specific functionality.',
+            forbiddenDeviceTypeUtilUsage: 'This portion of the CVSDK is device agnostic. Please do not directly use the utils/device-type module for device specific functionality.',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=no-device-type-imports.js.map

package/build/rules/no-device-type-imports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-device-type-imports.js","sourceRoot":"","sources":["../../src/rules/no-device-type-imports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAEtE,IAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAE3D,MAAM,CAAC,IAAM,IAAI,GAAG,UAAU,CAAC;IAC3B,MAAM,YAAC,OAAO;QACV,OAAO;YACH,6HAA6H,EAAE,UAC3H,IAAoC;gBAEpC,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,MAAA;oBACJ,SAAS,EAAE,0BAA0B;iBACxC,CAAC,CAAC;YACP,CAAC;YACD,0FAA0F;YAC1F,mEAAmE;YACnE,qEAAqE,EAAE,UAAC,IAAI;gBACxE,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,MAAA;oBACJ,SAAS,EAAE,8BAA8B;iBAC5C,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,sCAAsC;SACtD;QACD,QAAQ,EAAE;YACN,wBAAwB,EACpB,wHAAwH;YAC5H,4BAA4B,EACxB,0IAA0I;SACjJ;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAClB;IACD,cAAc,EAAE,EAAE;CACrB,CAAC,CAAC"}

package/build/rules/prefer-private-exposables.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rule: ESLintUtils.RuleModule<"preferPrivateExposable", never[], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=prefer-private-exposables.d.ts.map

package/build/rules/prefer-private-exposables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-private-exposables.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-private-exposables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAItE,eAAO,MAAM,IAAI,8FAyBf,CAAC"}

package/build/rules/prefer-private-exposables.js

@@ -0,0 +1,30 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) { return name; });
+export var rule = createRule({
+    create: function (context) {
+        var _a;
+        var publicExposableNames = ['Ad', 'AdBreak', 'AdPosition', 'Track'];
+        var selector = publicExposableNames.map(function (name) { return "ImportSpecifier[imported.name=".concat(name, "]"); }).join(', ');
+        return _a = {},
+            _a["Program:has(".concat(selector, ")")] = function (node) {
+                context.report({
+                    node: node,
+                    messageId: 'preferPrivateExposable',
+                });
+            },
+            _a;
+    },
+    name: 'prefer-private-exposables',
+    meta: {
+        docs: {
+            description: 'Prefer private versions of exposables within CVSDK core',
+        },
+        messages: {
+            preferPrivateExposable: 'Please use Internal variant of public data type (eg. AdBreakInternal instead of AdBreak) inside the core',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=prefer-private-exposables.js.map

package/build/rules/prefer-private-exposables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-private-exposables.js","sourceRoot":"","sources":["../../src/rules/prefer-private-exposables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAEtE,IAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAE3D,MAAM,CAAC,IAAM,IAAI,GAAG,UAAU,CAAC;IAC3B,MAAM,YAAC,OAAO;;QACV,IAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACtE,IAAM,QAAQ,GAAG,oBAAoB,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,wCAAiC,IAAI,MAAG,EAAxC,CAAwC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzG;YACI,GAAC,sBAAe,QAAQ,MAAG,IAAG,UAAC,IAAoC;gBAC/D,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,MAAA;oBACJ,SAAS,EAAE,wBAAwB;iBACtC,CAAC,CAAC;YACP,CAAC;eACH;IACN,CAAC;IACD,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,yDAAyD;SACzE;QACD,QAAQ,EAAE;YACN,sBAAsB,EAAE,0GAA0G;SACrI;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAClB;IACD,cAAc,EAAE,EAAE;CACrB,CAAC,CAAC"}

package/package.json

@@ -1,26 +1,26 @@
 {
-    "name": "eslint-plugin-cvsdk-rules",
-    "version": "14.0.2-protected",
-    "main": "./build/index.js",
-    "type": "module",
-    "scripts": {
-        "test": "jest",
-        "test:nocoverage": "jest",
-        "build": "tsc"
-    },
-    "dependencies": {
-        "typescript-eslint": "8.8.0"
-    },
-    "devDependencies": {
-        "@eslint/js": "^9.8.0",
-        "@types/eslint": "^9.6.0",
-        "@types/eslint__js": "^8.42.3",
-        "@types/node": "^22.0.2",
-        "@typescript-eslint/rule-tester": "8.8.0",
-        "console-fail-test": "^0.5.0",
-        "eslint": "^9.8.0",
-        "eslint-plugin-eslint-plugin": "6.2.0",
-        "typescript": "5.2.2"
-    },
-    "gitHead": "2ba2b73a8b29fd88ed9d7bcbd0983f501275653e"
-}
+  "name": "eslint-plugin-cvsdk-rules",
+  "version": "14.1.0-alpha.2-protected",
+  "main": "./build/index.js",
+  "type": "module",
+  "dependencies": {
+    "typescript-eslint": "8.8.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "@types/eslint": "^9.6.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.0.2",
+    "@typescript-eslint/utils": "8.34.0",
+    "@typescript-eslint/rule-tester": "8.8.0",
+    "console-fail-test": "^0.5.0",
+    "eslint": "^9.8.0",
+    "eslint-plugin-eslint-plugin": "6.2.0",
+    "typescript": "5.2.2"
+  },
+  "scripts": {
+    "test": "jest",
+    "test:nocoverage": "jest",
+    "build": "tsc"
+  }
+}

package/src/index.ts

@@ -1,11 +1,15 @@
 import { rule as preferSelfOverWindow } from './rules/prefer-self-over-window.js';
 import { rule as preferTxmlOverDomParser } from './rules/prefer-txml-over-domparser.js';
 import { rule as preferNoLodashCloneDeep } from './rules/prefer-no-lodash-clone-deep.js';
+import { rule as noDeviceTypeImports } from './rules/no-device-type-imports.js';
+import { rule as preferPrivateExposables } from './rules/prefer-private-exposables.js';
 
 const rules = {
     'prefer-no-lodash-cloneDeep': preferNoLodashCloneDeep,
     'prefer-self-over-window': preferSelfOverWindow,
     'prefer-txml-over-domparser': preferTxmlOverDomParser,
+    'no-device-type-imports': noDeviceTypeImports,
+    'prefer-private-exposables': preferPrivateExposables,
 };
 
 const plugin = {

package/src/rules/no-device-type-imports.ts

@@ -0,0 +1,41 @@
+import { ESLintUtils, type TSESTree } from '@typescript-eslint/utils';
+
+const createRule = ESLintUtils.RuleCreator((name) => name);
+
+export const rule = createRule({
+    create(context) {
+        return {
+            "Program:has(ImportDeclaration[source.value='@sky-uk-ott/client-lib-js-device'] > ImportSpecifier[imported.name=DeviceType])": (
+                node: TSESTree.Node | TSESTree.Token
+            ) => {
+                context.report({
+                    node,
+                    messageId: 'forbiddenDeviceTypeUsage',
+                });
+            },
+            // Note the unicode character here is required to match a forward slash in the import path
+            // See https://eslint.org/docs/latest/extend/selectors#known-issues
+            'Program:has(ImportDeclaration[source.value=/.*\\u002Fdevice-type/])': (node) => {
+                context.report({
+                    node,
+                    messageId: 'forbiddenDeviceTypeUtilUsage',
+                });
+            },
+        };
+    },
+    name: 'no-device-type-imports',
+    meta: {
+        docs: {
+            description: 'Detect DeviceType usage in the CVSDK',
+        },
+        messages: {
+            forbiddenDeviceTypeUsage:
+                'This portion of the CVSDK is device agnostic. Please do not directly use DeviceType for device specific functionality.',
+            forbiddenDeviceTypeUtilUsage:
+                'This portion of the CVSDK is device agnostic. Please do not directly use the utils/device-type module for device specific functionality.',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});

package/src/rules/prefer-private-exposables.ts

@@ -0,0 +1,30 @@
+import { ESLintUtils, type TSESTree } from '@typescript-eslint/utils';
+
+const createRule = ESLintUtils.RuleCreator((name) => name);
+
+export const rule = createRule({
+    create(context) {
+        const publicExposableNames = ['Ad', 'AdBreak', 'AdPosition', 'Track'];
+        const selector = publicExposableNames.map((name) => `ImportSpecifier[imported.name=${name}]`).join(', ');
+        return {
+            [`Program:has(${selector})`]: (node: TSESTree.Node | TSESTree.Token) => {
+                context.report({
+                    node,
+                    messageId: 'preferPrivateExposable',
+                });
+            },
+        };
+    },
+    name: 'prefer-private-exposables',
+    meta: {
+        docs: {
+            description: 'Prefer private versions of exposables within CVSDK core',
+        },
+        messages: {
+            preferPrivateExposable: 'Please use Internal variant of public data type (eg. AdBreakInternal instead of AdBreak) inside the core',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});