@w5s/configurator-core 1.0.0-alpha.1

package/dist/index.d.cts

@@ -0,0 +1,304 @@
+//#region src/FileMode.d.ts
+interface FilePermissionSet {
+  /**
+   * Read permission
+   */
+  readonly read?: boolean;
+  /**
+   * Write permission
+   */
+  readonly write?: boolean;
+  /**
+   * Execute permission
+   */
+  readonly execute?: boolean;
+}
+interface FileMode {
+  /**
+   * Owner permissions
+   */
+  readonly owner?: FilePermissionSet;
+  /**
+   * Group permissions
+   */
+  readonly group?: FilePermissionSet;
+  /**
+   * Other permissions
+   */
+  readonly other?: FilePermissionSet;
+}
+//#endregion
+//#region src/directory.d.ts
+interface DirectoryOptions {
+  /**
+   * Directory path
+   */
+  readonly path: string;
+  /**
+   * Directory target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * File permissions
+   */
+  readonly mode?: FileMode;
+}
+/**
+ * Ensure directory is present/absent
+ *
+ * @example
+ * ```ts
+ * await directory({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function directory(options: DirectoryOptions): Promise<void>;
+/**
+ * Ensure directory is present/absent
+ *
+ * @example
+ * ```ts
+ * directorySync({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function directorySync(options: DirectoryOptions): void;
+//#endregion
+//#region src/block.d.ts
+interface BlockOptions {
+  /**
+   * The marker builder function that will take either `markerBegin` or `markerEnd`
+   *
+   * @default '# ${mark} MANAGED BLOCK'
+   */
+  marker?: (mark: 'Begin' | 'End') => string;
+  /**
+   * File path
+   */
+  path: string;
+  /**
+   * Block content to insert
+   */
+  block: string;
+  /**
+   * Insert position
+   */
+  insertPosition?: ['before', 'BeginningOfFile' | RegExp] | ['after', 'EndOfFile' | RegExp];
+  /**
+   * Block target state
+   */
+  state?: 'present' | 'absent';
+}
+/**
+ * Replace asynchronously a block in file that follows pattern :
+ *
+ * marker(markerBegin)
+ * ...
+ * marker(markerEnd)
+ *
+ * @param options
+ */
+declare function block(options: BlockOptions): Promise<void>;
+/**
+ * Replace synchronously a block in file that follows pattern :
+ *
+ * marker(markerBegin)
+ * ...
+ * marker(markerEnd)
+ *
+ * @param options
+ */
+declare function blockSync(options: BlockOptions): void;
+//#endregion
+//#region src/file.d.ts
+interface FileOptions {
+  /**
+   * File path
+   */
+  readonly path: string;
+  /**
+   * File target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * File content mapping function
+   *
+   */
+  readonly update?: ((content: string) => string | undefined) | undefined;
+  /**
+   * File encoding
+   */
+  readonly encoding?: BufferEncoding;
+  /**
+   * File permissions
+   */
+  readonly mode?: FileMode;
+}
+/**
+ * Ensure file is present/absent with content initialized or modified with `update
+ *
+ * @example
+ * ```ts
+ * await file({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   update: (content) => content + '_test', // This will append '_test' after current content
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function file(options: FileOptions): Promise<void>;
+/**
+ * Ensure file is present/absent with content initialized or modified with `update
+ *
+ * @example
+ * ```ts
+ * fileSync({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   update: (content) => content + '_test', // This will append '_test' after current content
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function fileSync(options: FileOptions): void;
+//#endregion
+//#region src/json.d.ts
+type JSONValue = null | number | string | boolean | JSONValue[] | {
+  [key: string]: JSONValue;
+};
+interface JSONOption<V = JSONValue> extends Omit<FileOptions, 'update'> {
+  /**
+   * File content mapping function
+   */
+  readonly update?: ((content: V | undefined) => V | undefined) | undefined;
+}
+/**
+ * Ensure file is present/absent asynchronously with content value initialized or modified with `update`
+ *
+ * @param options
+ */
+declare function json<Value>(options: JSONOption<Value>): Promise<void>;
+/**
+ * Ensure file is present/absent synchronously with content value initialized or modified with `update`
+ *
+ * @param options
+ */
+declare function jsonSync<Value>(options: JSONOption<Value>): void;
+//#endregion
+//#region src/meta.d.ts
+declare const meta: Readonly<{
+  name: string;
+  version: string;
+  buildNumber: number;
+}>;
+//#endregion
+//#region src/yarnConfig.d.ts
+interface YarnConfigOptions {
+  /**
+   * Configuration key
+   */
+  readonly key: string;
+  /**
+   * Option target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * File content mapping function
+   *
+   */
+  readonly update?: ((content: string) => string | undefined) | undefined;
+}
+/**
+ * Synchronous version of {@link yarnConfig}
+ *
+ * @param options
+ * @example
+ * yarnConfigSync({
+ *   key: 'nodeLinker',
+ *   state: 'present',
+ *   update: (content) => content.replace('node-modules', 'hoisted'),
+ * })
+ */
+declare function yarnConfigSync(options: YarnConfigOptions): void;
+/**
+ * Set/Unset yarn configuration value
+ *
+ * @param options
+ * @example
+ * await yarnConfig({
+ *   key: 'nodeLinker',
+ *   state: 'present',
+ *   update: (content) => content.replace('node-modules', 'hoisted'),
+ * })
+ */
+declare function yarnConfig(options: YarnConfigOptions): Promise<void>;
+//#endregion
+//#region src/yarnVersion.d.ts
+type YarnVersionKind = 'berry' | 'classic';
+interface YarnVersionOptions {
+  /**
+   * Option target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * Version mapping function
+   *
+   */
+  readonly update?: (() => YarnVersionKind | undefined) | undefined;
+}
+/**
+ * Synchronous version of {@link yarnVersion}
+ *
+ * @param options
+ * @example
+ * yarnVersionSync({
+ *   state: 'present',
+ *   update: () => 'berry', // or 'classic'
+ * })
+ */
+declare function yarnVersionSync(options: YarnVersionOptions): void;
+/**
+ * Set/Unset yarn configuration value
+ *
+ * @param options
+ * @example
+ * await yarnVersion({
+ *   state: 'present',
+ *   update: () => 'berry', // or 'classic'
+ * })
+ */
+declare function yarnVersion(options: YarnVersionOptions): Promise<void>;
+//#endregion
+export { BlockOptions, DirectoryOptions, FileOptions, JSONOption, JSONValue, YarnConfigOptions, YarnVersionKind, YarnVersionOptions, block, blockSync, directory, directorySync, file, fileSync, json, jsonSync, meta, yarnConfig, yarnConfigSync, yarnVersion, yarnVersionSync };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/FileMode.ts","../src/directory.ts","../src/block.ts","../src/file.ts","../src/json.ts","../src/meta.ts","../src/yarnConfig.ts","../src/yarnVersion.ts"],"mappings":";UAAiB,iBAAA;EAAA;;;EAAA,SAIN,IAAA;EAAA;;;EAAA,SAKA,KAAA;EAKO;AAGlB;;EAHkB,SAAP,OAAA;AAAA;AAAA,UAGM,QAAA;EAcE;;;EAAA,SAVR,KAAA,GAAQ,iBAAA;EAAA;;;EAAA,SAKR,KAAA,GAAQ,iBAAA;EAKA;;;EAAA,SAAR,KAAA,GAAQ,iBAAA;AAAA;;;UCxBF,gBAAA;EDPiB;;;EAAA,SCWvB,IAAA;EDFA;;;EAAA,SCOA,KAAA;EDCM;;;EAAA,SCIN,IAAA,GAAO,QAAA;AAAA;;;;;;;;;;;;;;;AAdlB;;;;iBAmCsB,SAAA,CAAU,OAAA,EAAS,gBAAA,GAAmB,OAAA;;;;;;AAA5D;;;;;;;;;AAkCA;;;;iBAAgB,aAAA,CAAc,OAAA,EAAS,gBAAA;;;UC1EtB,YAAA;EFFA;;;;;EEQf,MAAA,IAAU,IAAA;EFMD;;;EEDT,IAAA;EFIuB;;;EECvB,KAAA;EFaiB;;;EERjB,cAAA,kCAAgD,MAAA,4BAAkC,MAAA;EFFjE;;;EEOjB,KAAA;AAAA;;;;;;ADrBF;;;;iBCkIgB,KAAA,CAAM,OAAA,EAAS,YAAA,GAAY,OAAA;;;;;;AD/F3C;;;;iBC4GgB,SAAA,CAAU,OAAA,EAAS,YAAA;;;UC/IlB,WAAA;EHPiB;;;EAAA,SGWvB,IAAA;EHFA;;;EAAA,SGOA,KAAA;EHCM;;;;EAAA,SGKN,MAAA,KAAW,OAAA;EHSH;;;EAAA,SGJR,QAAA,GAAW,cAAA;EHNH;;;EAAA,SGWR,IAAA,GAAO,QAAA;AAAA;;;;;;AFzBlB;;;;;;;;;;AAmCA;;;;iBEYsB,IAAA,CAAK,OAAA,EAAS,WAAA,GAAc,OAAA;;;;;AFsBlD;;;;;;;;AC1EA;;;;;;;iBCyFgB,QAAA,CAAS,OAAA,EAAS,WAAA;;;KCzFtB,SAAA,sCAA+C,SAAA;EAAA,CAAiB,GAAA,WAAc,SAAA;AAAA;AAAA,UAEzE,UAAA,KAAe,SAAA,UAAmB,IAAA,CAAK,WAAA;EJA7C;;;EAAA,SIIA,MAAA,KAAW,OAAA,EAAS,CAAA,iBAAkB,CAAA;AAAA;AJSjD;;;;;AAAA,iBIcsB,IAAA,OAAA,CAAY,OAAA,EAAS,UAAA,CAAW,KAAA,IAAS,OAAA;;;;;;iBAS/C,QAAA,OAAA,CAAgB,OAAA,EAAS,UAAA,CAAW,KAAA;;;cCxCvC,IAAA,EAAI,QAAA;;;;;;;UCEA,iBAAA;ENFA;;;EAAA,SMMN,GAAA;ENFA;;;EAAA,SMOA,KAAA;ENGO;AAGlB;;;EAHkB,SMGP,MAAA,KAAW,OAAA;AAAA;;;;;;;;;;;;iBAcN,cAAA,CAAe,OAAA,EAAS,iBAAA;;;ALxBxC;;;;;;;;;iBK6CsB,UAAA,CAAW,OAAA,EAAS,iBAAA,GAAoB,OAAA;;;KClDlD,eAAA;AAAA,UAEK,kBAAA;EPJiB;;;EAAA,SOQvB,KAAA;EPCA;;;;EAAA,SOKA,MAAA,UAAgB,eAAA;AAAA;;;;;;;;;;;iBAaX,eAAA,CAAgB,OAAA,EAAS,kBAAA;;;;;;;ANpBzC;;;;iBMwCsB,WAAA,CAAY,OAAA,EAAS,kBAAA,GAAqB,OAAA"}

package/dist/index.d.ts

@@ -0,0 +1,304 @@
+//#region src/FileMode.d.ts
+interface FilePermissionSet {
+  /**
+   * Read permission
+   */
+  readonly read?: boolean;
+  /**
+   * Write permission
+   */
+  readonly write?: boolean;
+  /**
+   * Execute permission
+   */
+  readonly execute?: boolean;
+}
+interface FileMode {
+  /**
+   * Owner permissions
+   */
+  readonly owner?: FilePermissionSet;
+  /**
+   * Group permissions
+   */
+  readonly group?: FilePermissionSet;
+  /**
+   * Other permissions
+   */
+  readonly other?: FilePermissionSet;
+}
+//#endregion
+//#region src/directory.d.ts
+interface DirectoryOptions {
+  /**
+   * Directory path
+   */
+  readonly path: string;
+  /**
+   * Directory target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * File permissions
+   */
+  readonly mode?: FileMode;
+}
+/**
+ * Ensure directory is present/absent
+ *
+ * @example
+ * ```ts
+ * await directory({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function directory(options: DirectoryOptions): Promise<void>;
+/**
+ * Ensure directory is present/absent
+ *
+ * @example
+ * ```ts
+ * directorySync({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function directorySync(options: DirectoryOptions): void;
+//#endregion
+//#region src/block.d.ts
+interface BlockOptions {
+  /**
+   * The marker builder function that will take either `markerBegin` or `markerEnd`
+   *
+   * @default '# ${mark} MANAGED BLOCK'
+   */
+  marker?: (mark: 'Begin' | 'End') => string;
+  /**
+   * File path
+   */
+  path: string;
+  /**
+   * Block content to insert
+   */
+  block: string;
+  /**
+   * Insert position
+   */
+  insertPosition?: ['before', 'BeginningOfFile' | RegExp] | ['after', 'EndOfFile' | RegExp];
+  /**
+   * Block target state
+   */
+  state?: 'present' | 'absent';
+}
+/**
+ * Replace asynchronously a block in file that follows pattern :
+ *
+ * marker(markerBegin)
+ * ...
+ * marker(markerEnd)
+ *
+ * @param options
+ */
+declare function block(options: BlockOptions): Promise<void>;
+/**
+ * Replace synchronously a block in file that follows pattern :
+ *
+ * marker(markerBegin)
+ * ...
+ * marker(markerEnd)
+ *
+ * @param options
+ */
+declare function blockSync(options: BlockOptions): void;
+//#endregion
+//#region src/file.d.ts
+interface FileOptions {
+  /**
+   * File path
+   */
+  readonly path: string;
+  /**
+   * File target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * File content mapping function
+   *
+   */
+  readonly update?: ((content: string) => string | undefined) | undefined;
+  /**
+   * File encoding
+   */
+  readonly encoding?: BufferEncoding;
+  /**
+   * File permissions
+   */
+  readonly mode?: FileMode;
+}
+/**
+ * Ensure file is present/absent with content initialized or modified with `update
+ *
+ * @example
+ * ```ts
+ * await file({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   update: (content) => content + '_test', // This will append '_test' after current content
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function file(options: FileOptions): Promise<void>;
+/**
+ * Ensure file is present/absent with content initialized or modified with `update
+ *
+ * @example
+ * ```ts
+ * fileSync({
+ *   path: 'foo/bar',
+ *   state: 'present',
+ *   update: (content) => content + '_test', // This will append '_test' after current content
+ *   mode: {
+ *     owner: { read: true, write: true, execute: true },
+ *     group: { read: true, write: true, execute: true },
+ *     other: { read: true, write: true, execute: true },
+ *   },
+ * })
+ * ```
+ *
+ * @param options
+ */
+declare function fileSync(options: FileOptions): void;
+//#endregion
+//#region src/json.d.ts
+type JSONValue = null | number | string | boolean | JSONValue[] | {
+  [key: string]: JSONValue;
+};
+interface JSONOption<V = JSONValue> extends Omit<FileOptions, 'update'> {
+  /**
+   * File content mapping function
+   */
+  readonly update?: ((content: V | undefined) => V | undefined) | undefined;
+}
+/**
+ * Ensure file is present/absent asynchronously with content value initialized or modified with `update`
+ *
+ * @param options
+ */
+declare function json<Value>(options: JSONOption<Value>): Promise<void>;
+/**
+ * Ensure file is present/absent synchronously with content value initialized or modified with `update`
+ *
+ * @param options
+ */
+declare function jsonSync<Value>(options: JSONOption<Value>): void;
+//#endregion
+//#region src/meta.d.ts
+declare const meta: Readonly<{
+  name: string;
+  version: string;
+  buildNumber: number;
+}>;
+//#endregion
+//#region src/yarnConfig.d.ts
+interface YarnConfigOptions {
+  /**
+   * Configuration key
+   */
+  readonly key: string;
+  /**
+   * Option target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * File content mapping function
+   *
+   */
+  readonly update?: ((content: string) => string | undefined) | undefined;
+}
+/**
+ * Synchronous version of {@link yarnConfig}
+ *
+ * @param options
+ * @example
+ * yarnConfigSync({
+ *   key: 'nodeLinker',
+ *   state: 'present',
+ *   update: (content) => content.replace('node-modules', 'hoisted'),
+ * })
+ */
+declare function yarnConfigSync(options: YarnConfigOptions): void;
+/**
+ * Set/Unset yarn configuration value
+ *
+ * @param options
+ * @example
+ * await yarnConfig({
+ *   key: 'nodeLinker',
+ *   state: 'present',
+ *   update: (content) => content.replace('node-modules', 'hoisted'),
+ * })
+ */
+declare function yarnConfig(options: YarnConfigOptions): Promise<void>;
+//#endregion
+//#region src/yarnVersion.d.ts
+type YarnVersionKind = 'berry' | 'classic';
+interface YarnVersionOptions {
+  /**
+   * Option target state
+   */
+  readonly state: 'present' | 'absent';
+  /**
+   * Version mapping function
+   *
+   */
+  readonly update?: (() => YarnVersionKind | undefined) | undefined;
+}
+/**
+ * Synchronous version of {@link yarnVersion}
+ *
+ * @param options
+ * @example
+ * yarnVersionSync({
+ *   state: 'present',
+ *   update: () => 'berry', // or 'classic'
+ * })
+ */
+declare function yarnVersionSync(options: YarnVersionOptions): void;
+/**
+ * Set/Unset yarn configuration value
+ *
+ * @param options
+ * @example
+ * await yarnVersion({
+ *   state: 'present',
+ *   update: () => 'berry', // or 'classic'
+ * })
+ */
+declare function yarnVersion(options: YarnVersionOptions): Promise<void>;
+//#endregion
+export { BlockOptions, DirectoryOptions, FileOptions, JSONOption, JSONValue, YarnConfigOptions, YarnVersionKind, YarnVersionOptions, block, blockSync, directory, directorySync, file, fileSync, json, jsonSync, meta, yarnConfig, yarnConfigSync, yarnVersion, yarnVersionSync };
+//# sourceMappingURL=index.d.ts.map