@rsdk/yarn.constraints 4.0.0-next.10

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [4.0.0-next.10](https://github.com/R-Vision/rsdk/compare/v4.0.0-next.9...v4.0.0-next.10) (2023-11-29)
+
+**Note:** Version bump only for package @rsdk/yarn.constraints
+
+## [4.0.0-next.9](https://github.com/R-Vision/rsdk/compare/v4.0.0-next.8...v4.0.0-next.9) (2023-11-29)
+
+**Note:** Version bump only for package @rsdk/yarn.constraints
+
+## [4.0.0-next.8](https://github.com/R-Vision/rsdk/compare/v4.0.0-next.7...v4.0.0-next.8) (2023-11-29)
+
+### Features
+
+* Kafka batch producer ([#150](https://github.com/R-Vision/rsdk/issues/150)) ([2faa2f4](https://github.com/R-Vision/rsdk/commit/2faa2f41ca0dbb6d8a92cbf0ab20cf5cefeaf4e9))
+
+## [4.0.0-next.7](https://github.com/R-Vision/rsdk/compare/v4.0.0-next.6...v4.0.0-next.7) (2023-11-21)
+
+### Features
+
+* check access to file ([b9fb6bc](https://github.com/R-Vision/rsdk/commit/b9fb6bcc0a4fe79cdc580c3f2154bdc0a8ad906c))
+* **yarn.constraints:** added constraints package
+  for `yarn constraints` ([3567951](https://github.com/R-Vision/rsdk/commit/3567951a47de667d3f3be5bb0f4892a9e6168087))

package/README.MD

@@ -0,0 +1,35 @@
+# @rsdk/yarn.constraints
+
+Tool for make consistent version dependencies in workspaces
+
+## .rsdk/.constraints
+
+```yaml
+some-package: 1.0.0
+"@scope":
+  scope-package: ~1.0.0
+```
+
+## Usage
+
+Default
+
+```js
+// yarn.config.js
+module.exports = require('@rsdk/yarn.constraints').config
+```
+
+With configuration
+
+```js
+// yarn.config.js
+module.exports = require('@rsdk/yarn.constraints').override(async (cfg) => {
+    // some actions, reference https://yarnpkg.com/features/constraints
+})
+```
+
+## Variables
+
+| Name                      | Description             | Default                  |
+|---------------------------|-------------------------|--------------------------|
+| RSDK_YARN_CONSTRAINTS_CFG | path to constraints yml | ./.rsdk/.constraints.yml |

package/dist/constraint-schema.d.ts

@@ -0,0 +1 @@
+export declare const ConstraintSchema: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>, import("@sinclair/typebox").TString]>>;

package/dist/constraint-schema.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConstraintSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+exports.ConstraintSchema = typebox_1.Type.Record(typebox_1.Type.String({
+    description: 'scope or package name',
+}), typebox_1.Type.Union([
+    typebox_1.Type.Record(typebox_1.Type.String({
+        description: 'scope package name',
+    }), typebox_1.Type.String({
+        description: 'scope package version',
+    })),
+    typebox_1.Type.String({
+        description: 'package version',
+    }),
+]));
+//# sourceMappingURL=constraint-schema.js.map

package/dist/constraint-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constraint-schema.js","sourceRoot":"","sources":["../src/constraint-schema.ts"],"names":[],"mappings":";;;AAAA,+CAAyC;AAE5B,QAAA,gBAAgB,GAAG,cAAI,CAAC,MAAM,CACzC,cAAI,CAAC,MAAM,CAAC;IACV,WAAW,EAAE,uBAAuB;CACrC,CAAC,EACF,cAAI,CAAC,KAAK,CAAC;IACT,cAAI,CAAC,MAAM,CACT,cAAI,CAAC,MAAM,CAAC;QACV,WAAW,EAAE,oBAAoB;KAClC,CAAC,EACF,cAAI,CAAC,MAAM,CAAC;QACV,WAAW,EAAE,uBAAuB;KACrC,CAAC,CACH;IACD,cAAI,CAAC,MAAM,CAAC;QACV,WAAW,EAAE,iBAAiB;KAC/B,CAAC;CACH,CAAC,CACH,CAAC"}

package/dist/dependency-checker.d.ts

@@ -0,0 +1,8 @@
+import type { Static } from '@sinclair/typebox';
+import type { Constraints } from '@yarnpkg/types/lib/yarn';
+import type { ConstraintSchema } from './constraint-schema';
+export declare class DependencyChecker {
+    private readonly yarn;
+    constructor(yarn: Constraints.Yarn);
+    enforceConsistentDependenciesAcrossTheProject(constraints: Static<typeof ConstraintSchema>, part?: string): void;
+}

package/dist/dependency-checker.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DependencyChecker = void 0;
+class DependencyChecker {
+    yarn;
+    constructor(yarn) {
+        this.yarn = yarn;
+    }
+    enforceConsistentDependenciesAcrossTheProject(constraints, part = '') {
+        for (const [packageOrPrefix, value] of Object.entries(constraints)) {
+            const resolvedName = [part, packageOrPrefix].filter(Boolean).join('/');
+            if (typeof value === 'string') {
+                for (const dep of this.yarn.dependencies({ ident: resolvedName })) {
+                    dep.update(value);
+                }
+                continue;
+            }
+            this.enforceConsistentDependenciesAcrossTheProject(value, resolvedName);
+        }
+    }
+}
+exports.DependencyChecker = DependencyChecker;
+//# sourceMappingURL=dependency-checker.js.map

package/dist/dependency-checker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependency-checker.js","sourceRoot":"","sources":["../src/dependency-checker.ts"],"names":[],"mappings":";;;AAKA,MAAa,iBAAiB;IACC;IAA7B,YAA6B,IAAsB;QAAtB,SAAI,GAAJ,IAAI,CAAkB;IAAG,CAAC;IAEvD,6CAA6C,CAC3C,WAA4C,EAC5C,IAAI,GAAG,EAAE;QAET,KAAK,MAAM,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAClE,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,EAAE;oBACjE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;iBACnB;gBACD,SAAS;aACV;YACD,IAAI,CAAC,6CAA6C,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;SACzE;IACH,CAAC;CACF;AAlBD,8CAkBC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import type { Yarn } from '@yarnpkg/types';
+import type { Constraints } from '@yarnpkg/types/lib/yarn';
+export declare const createConstraints: (overrideConfig?: Yarn.Config) => (ctx: Constraints.Context) => Promise<void>;
+export declare const config: Yarn.Config;
+export declare const override: (config: Yarn.Config) => Yarn.Config;

package/dist/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.override = exports.config = exports.createConstraints = void 0;
+const value_1 = require("@sinclair/typebox/value");
+const promises_1 = require("node:fs/promises");
+const yaml_1 = __importDefault(require("yaml"));
+const constraint_schema_1 = require("./constraint-schema");
+const dependency_checker_1 = require("./dependency-checker");
+const constraintsManifestPath = process.env.RSDK_YARN_CONSTRAINTS_CFG ?? './.rsdk/.constraints.yml';
+const createConstraints = (overrideConfig) => async (ctx) => {
+    const { Yarn } = ctx;
+    await (0, promises_1.access)(constraintsManifestPath, promises_1.constants.R_OK);
+    const constraints = yaml_1.default.parse(await (0, promises_1.readFile)(constraintsManifestPath, 'utf8'));
+    const isValid = value_1.Value.Check(constraint_schema_1.ConstraintSchema, constraints);
+    if (!isValid) {
+        const cause = [...value_1.Value.Errors(constraint_schema_1.ConstraintSchema, constraints)];
+        throw new Error('Invalid constraints.yml\n' + JSON.stringify(cause, null, 2), {
+            cause: cause,
+        });
+    }
+    new dependency_checker_1.DependencyChecker(Yarn).enforceConsistentDependenciesAcrossTheProject(constraints);
+    overrideConfig?.constraints?.(ctx);
+};
+exports.createConstraints = createConstraints;
+exports.config = {
+    constraints: (0, exports.createConstraints)(),
+};
+const override = (config) => ({
+    ...config,
+    constraints: (0, exports.createConstraints)(config),
+});
+exports.override = override;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAgD;AAGhD,+CAA+D;AAC/D,gDAAwB;AAExB,2DAAuD;AACvD,6DAAyD;AAEzD,MAAM,uBAAuB,GAC3B,OAAO,CAAC,GAAG,CAAC,yBAAyB,IAAI,0BAA0B,CAAC;AAE/D,MAAM,iBAAiB,GAC5B,CAAC,cAA4B,EAAE,EAAE,CACjC,KAAK,EAAE,GAAwB,EAAiB,EAAE;IAChD,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;IAErB,MAAM,IAAA,iBAAM,EAAC,uBAAuB,EAAE,oBAAS,CAAC,IAAI,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,cAAI,CAAC,KAAK,CAC5B,MAAM,IAAA,mBAAQ,EAAC,uBAAuB,EAAE,MAAM,CAAC,CAChD,CAAC;IACF,MAAM,OAAO,GAAG,aAAK,CAAC,KAAK,CAAC,oCAAgB,EAAE,WAAW,CAAC,CAAC;IAC3D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,KAAK,GAAG,CAAC,GAAG,aAAK,CAAC,MAAM,CAAC,oCAAgB,EAAE,WAAW,CAAC,CAAC,CAAC;QAE/D,MAAM,IAAI,KAAK,CACb,2BAA2B,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAC5D;YACE,KAAK,EAAE,KAAK;SACb,CACF,CAAC;KACH;IACD,IAAI,sCAAiB,CAAC,IAAI,CAAC,CAAC,6CAA6C,CACvE,WAAW,CACZ,CAAC;IACF,cAAc,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC;AACrC,CAAC,CAAC;AAxBS,QAAA,iBAAiB,qBAwB1B;AAES,QAAA,MAAM,GAAgB;IACjC,WAAW,EAAE,IAAA,yBAAiB,GAAE;CACjC,CAAC;AAEK,MAAM,QAAQ,GAAG,CAAC,MAAmB,EAAe,EAAE,CAAC,CAAC;IAC7D,GAAG,MAAM;IACT,WAAW,EAAE,IAAA,yBAAiB,EAAC,MAAM,CAAC;CACvC,CAAC,CAAC;AAHU,QAAA,QAAQ,YAGlB"}

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@rsdk/yarn.constraints",
+  "version": "4.0.0-next.10",
+  "description": "Useful common classes, functions and types",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "dependencies": {
+    "@sinclair/typebox": "^0.31.25",
+    "yaml": "^2.3.4"
+  },
+  "gitHead": "c41d4da9aa0318d5e6417514c763618ce924f9b7"
+}

package/src/constraint-schema.ts

@@ -0,0 +1,20 @@
+import { Type } from '@sinclair/typebox';
+
+export const ConstraintSchema = Type.Record(
+  Type.String({
+    description: 'scope or package name',
+  }),
+  Type.Union([
+    Type.Record(
+      Type.String({
+        description: 'scope package name',
+      }),
+      Type.String({
+        description: 'scope package version',
+      }),
+    ),
+    Type.String({
+      description: 'package version',
+    }),
+  ]),
+);

package/src/dependency-checker.ts

@@ -0,0 +1,24 @@
+import type { Static } from '@sinclair/typebox';
+import type { Constraints } from '@yarnpkg/types/lib/yarn';
+
+import type { ConstraintSchema } from './constraint-schema';
+
+export class DependencyChecker {
+  constructor(private readonly yarn: Constraints.Yarn) {}
+
+  enforceConsistentDependenciesAcrossTheProject(
+    constraints: Static<typeof ConstraintSchema>,
+    part = '',
+  ): void {
+    for (const [packageOrPrefix, value] of Object.entries(constraints)) {
+      const resolvedName = [part, packageOrPrefix].filter(Boolean).join('/');
+      if (typeof value === 'string') {
+        for (const dep of this.yarn.dependencies({ ident: resolvedName })) {
+          dep.update(value);
+        }
+        continue;
+      }
+      this.enforceConsistentDependenciesAcrossTheProject(value, resolvedName);
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,46 @@
+import { Value } from '@sinclair/typebox/value';
+import type { Yarn } from '@yarnpkg/types';
+import type { Constraints } from '@yarnpkg/types/lib/yarn';
+import { access, constants, readFile } from 'node:fs/promises';
+import yaml from 'yaml';
+
+import { ConstraintSchema } from './constraint-schema';
+import { DependencyChecker } from './dependency-checker';
+
+const constraintsManifestPath =
+  process.env.RSDK_YARN_CONSTRAINTS_CFG ?? './.rsdk/.constraints.yml';
+
+export const createConstraints =
+  (overrideConfig?: Yarn.Config) =>
+  async (ctx: Constraints.Context): Promise<void> => {
+    const { Yarn } = ctx;
+
+    await access(constraintsManifestPath, constants.R_OK);
+    const constraints = yaml.parse(
+      await readFile(constraintsManifestPath, 'utf8'),
+    );
+    const isValid = Value.Check(ConstraintSchema, constraints);
+    if (!isValid) {
+      const cause = [...Value.Errors(ConstraintSchema, constraints)];
+
+      throw new Error(
+        'Invalid constraints.yml\n' + JSON.stringify(cause, null, 2),
+        {
+          cause: cause,
+        },
+      );
+    }
+    new DependencyChecker(Yarn).enforceConsistentDependenciesAcrossTheProject(
+      constraints,
+    );
+    overrideConfig?.constraints?.(ctx);
+  };
+
+export const config: Yarn.Config = {
+  constraints: createConstraints(),
+};
+
+export const override = (config: Yarn.Config): Yarn.Config => ({
+  ...config,
+  constraints: createConstraints(config),
+});

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@rsdk/tsconfig/base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist"
+  },
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "**/*spec.ts"
+  ]
+}