@simple-reporting/base 0.1.111 → 1.0.0

package/scripts/config.d.ts

@@ -1 +1,9 @@
 export const packageName: "@simple-reporting/base";
+export const baseComponentsToInstall: string[];
+export const nsWowInternalLddUrl: "https://nswow-ld.nswow.ch/designs";
+declare namespace _default {
+    export { packageName };
+    export { baseComponentsToInstall };
+    export { nsWowInternalLddUrl };
+}
+export default _default;

package/scripts/config.js

@@ -1 +1,52 @@
-export const packageName = '@simple-reporting/base';
+export const packageName = '@simple-reporting/base';
+
+export const baseComponentsToInstall = [
+  '010.Titles/010.title-h1',
+  '010.Titles/020.title-h2',
+  '010.Titles/030.title-h3',
+  '010.Titles/040.title-h4',
+  '010.Titles/050.title-h5',
+  '010.Titles/060.title-h6',
+  '020.Text/010.lead',
+  '020.Text/020.paragraph',
+  '020.Text/040.link',
+  '020.Text/050.quote',
+  '020.Text/060.quote-with-portrait',
+  '020.Text/070.footnote-container',
+  '020.Text/080.footnote-item',
+  '030.Lists/010.unordered-list',
+  '030.Lists/020.ordered-list',
+  '030.Lists/030.alphanumeric-list',
+  '030.Lists/040.list-item',
+  '040.Media/010.table',
+  '040.Media/020.image',
+  '040.Media/030.video',
+  '040.Media/040.interactive-element',
+  '070.Container/010.aside-content-container',
+  '070.Container/020.columns-container',
+  '080.CV/010.cv',
+  '080.CV/020.cv-time-span',
+  '090.Signatures/010.signature-container',
+  '090.Signatures/020.signature-item',
+  '100.Misc/010.anchor',
+  '110.PDF/010.pdf-pagebreak',
+  '110.PDF/030.pdf-publication-title',
+  '110.PDF/040.pdf-chapter-title',
+  '110.PDF/070.pdf-cover',
+  '110.PDF/080.pdf-toc-page',
+  '110.PDF/090.pdf-toc-item-title',
+  '110.PDF/100.pdf-toc-item',
+  '110.PDF/110.pdf-toc-item-blank',
+  '999.Properties/alignment',
+  '999.Properties/hide-quote-characters',
+  '999.Properties/pdf-spacer',
+  '999.Properties/width'
+];
+
+export const nsWowInternalLddUrl = 'https://nswow-ld.nswow.ch/designs';
+
+export default {
+  packageName,
+  baseComponentsToInstall,
+  nsWowInternalLddUrl,
+};

package/scripts/doPublish.js

@@ -1,43 +1,55 @@
-import { execSync } from 'child_process';
-import { preparePublish } from './preparePublish.js';
-import { packageName } from './config.js';
-
-export async function doPublish(version = null) {
-  try {
-    const publishVersion = await preparePublish(version);
-
-    const tag = `v${publishVersion.split('.')[0]}-lts`;
-
-    await execSync(`npm publish --tag ${tag}`, { stdio: 'inherit' });
-
-    console.log(
-      `Package ${packageName}@${publishVersion} published successfully!`,
-    );
-  } catch (error) {
-    console.error('Error during publishing:', error);
-  }
-}
-
-if (import.meta.url === `file://${process.argv[1]}`) {
-  try {
-    let version = null;
-    const indexVersion = process.argv.indexOf('-v');
-    if (indexVersion !== -1) {
-      if (!process.argv[indexVersion + 1]) {
-        throw new Error('Version argument is missing after -v');
-      }
-
-      const newVersion = process.argv[indexVersion + 1];
-      if (/^\d+\.\d+\.\d+$/.test(newVersion)) {
-        version = newVersion;
-      } else {
-        throw new Error(
-          `Invalid version format ${newVersion}. Use $number.$number.$number`,
-        );
-      }
-    }
-    doPublish(version);
-  } catch (error) {
-    console.error(error);
-  }
-}
+import { execSync } from 'child_process';
+import { preparePublish } from './preparePublish.js';
+import { packageName } from './config.js';
+import { getPackageVersion } from './utils.js';
+
+export async function doPublish(version = null) {
+  try {
+    const publishVersion = await preparePublish(version);
+
+    const tag = `v${publishVersion.split('.')[0]}-lts`;
+
+    await execSync(`npm publish --tag ${tag}`, { stdio: 'inherit' });
+
+    const latest = await getPackageVersion(packageName);
+
+    if (publishVersion > latest) {
+      await execSync(
+        `npm dist-tag add ${packageName}@${publishVersion} latest`,
+        {
+          stdio: 'inherit',
+        },
+      );
+    }
+
+    console.log(
+      `Package ${packageName}@${publishVersion} published successfully!`,
+    );
+  } catch (error) {
+    console.error('Error during publishing:', error);
+  }
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  try {
+    let version = null;
+    const indexVersion = process.argv.indexOf('-v');
+    if (indexVersion !== -1) {
+      if (!process.argv[indexVersion + 1]) {
+        throw new Error('Version argument is missing after -v');
+      }
+
+      const newVersion = process.argv[indexVersion + 1];
+      if (/^\d+\.\d+\.\d+$/.test(newVersion)) {
+        version = newVersion;
+      } else {
+        throw new Error(
+          `Invalid version format ${newVersion}. Use $number.$number.$number`,
+        );
+      }
+    }
+    doPublish(version);
+  } catch (error) {
+    console.error(error);
+  }
+}

package/scripts/folders.d.ts

@@ -0,0 +1,43 @@
+export const root: string;
+export const packageName: string;
+export const packagePath: string;
+export const packageSrl: string;
+export const packageLd: string;
+export const srlRoot: string;
+export const srlSystem: string;
+export const srlComponents: string;
+export const srlComposables: string;
+export const srlUtils: string;
+export const srlPlugins: string;
+export const srlScss: string;
+export const srlImports: string;
+export const srlTypes: string;
+export const srlOutput: string;
+export const srlPublic: string;
+export const srlSrc: string;
+export const srlAssets: string;
+export const srlEntries: string;
+export const ld: string;
+declare namespace _default {
+    export { root };
+    export { packageName };
+    export { packagePath };
+    export { packageSrl };
+    export { packageLd };
+    export { srlRoot };
+    export { srlSystem };
+    export { srlComponents };
+    export { srlComposables };
+    export { srlUtils };
+    export { srlPlugins };
+    export { srlScss };
+    export { srlImports };
+    export { srlTypes };
+    export { srlOutput };
+    export { srlPublic };
+    export { srlSrc };
+    export { srlAssets };
+    export { srlEntries };
+    export { ld };
+}
+export default _default;

package/scripts/folders.js

@@ -0,0 +1,46 @@
+import { join } from 'path/posix';
+import { packageName as configPackageName } from './config.js';
+
+export const root = process.cwd();
+export const packageName = join(...configPackageName.split('/'));
+export const packagePath = join(root, 'node_modules', packageName);
+export const packageSrl = join(packagePath, 'srl');
+export const packageLd = join(packagePath, 'livingdocs');
+export const srlRoot = join(root, '.srl');
+export const srlSystem = join(srlRoot, 'srl');
+export const srlComponents = join(srlRoot, 'components');
+export const srlComposables = join(srlRoot, 'composables');
+export const srlUtils = join(srlRoot, 'utils');
+export const srlPlugins = join(srlRoot, 'plugins');
+export const srlScss = join(srlRoot, 'scss');
+export const srlImports = join(srlRoot, 'imports');
+export const srlTypes = join(srlRoot, 'types');
+export const srlOutput = join(root, '.output');
+export const srlPublic = join(root, 'public');
+export const srlSrc = join(root, 'src');
+export const srlAssets = join(srlSrc, 'assets');
+export const srlEntries = join(srlSrc, 'entries');
+export const ld = join(root, 'livingdocs');
+
+export default {
+  root,
+  packageName,
+  packagePath,
+  packageSrl,
+  packageLd,
+  srlRoot,
+  srlSystem,
+  srlComponents,
+  srlComposables,
+  srlUtils,
+  srlPlugins,
+  srlScss,
+  srlImports,
+  srlTypes,
+  srlOutput,
+  srlPublic,
+  srlSrc,
+  srlAssets,
+  srlEntries,
+  ld,
+};

package/scripts/init.js

@@ -1,45 +1,65 @@
-import { resolve, dirname } from 'node:path';
-import fs from 'fs-extra';
-import { statSync, readFileSync, writeFileSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
-import { createRequire } from 'node:module';
-import writeJson from 'write-json';
-
-const require = createRequire(import.meta.url);
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-/**
- * Initializes a new project in the given folder with the provided options.
- *
- * @param {string} folder - The path to the folder where the project will be created.
- * @param {object} options - Additional options for the initialization process.
- *
- * @return {Promise<void>} - A promise that resolves when the project initialization is complete.
- */
-async function init(folder, options) {
-  const projectPath = resolve(process.cwd(), folder);
-
-  try {
-    const stat = statSync(projectPath);
-    console.error(`Folder ${projectPath} already exist!`);
-  } catch (e) {
-    await fs.copy(resolve(__dirname, '../dev/'), projectPath).then(async () => {
-      const packageJsonFile = `${projectPath}/package.json`;
-      const packageJson = JSON.parse(await readFileSync(packageJsonFile));
-      packageJson.name = folder;
-      const writeJson = require('write-json');
-      writeJson.sync(packageJsonFile, packageJson);
-
-      await writeFileSync(
-        `${projectPath}/.gitignore`,
-        `/.output/\n/.nswow/\n/node_modules/\n/public/downloads/\n/public/html/\n/public/images/\n/public/json/\n/public/exclude/\n/dev-dist/`,
-      );
-      console.log(`Project has created`);
-      console.log(`cd ${folder}`);
-      console.log(`npm install`);
-    });
-  }
-}
-
-export { init };
+import { dirname, join } from 'node:path';
+import fs from 'fs-extra';
+import { statSync, readFileSync, writeFileSync, cpSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { createRequire } from 'node:module';
+import { baseComponentsToInstall } from './config.js';
+
+const require = createRequire(import.meta.url);
+
+const { Input } = require('enquirer');
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * Initializes a new project in the given folder with the provided options.
+ *
+ * @param {string} folder - The path to the folder where the project will be created.
+ * @param {object} options - Additional options for the initialization process.
+ *
+ * @return {Promise<void>} - A promise that resolves when the project initialization is complete.
+ */
+async function init(folder, options) {
+  const prompt = new Input({
+    message: 'Project name',
+    initial: folder,
+  });
+  let projectName = await prompt.run();
+  if (projectName === '') {
+    projectName = folder;
+  }
+
+  const projectPath = join(process.cwd(), folder);
+
+  try {
+    const stat = statSync(projectPath);
+    console.error(`Folder ${projectPath} already exist!`);
+  } catch (e) {
+    await fs.copy(join(__dirname, '..', 'dev'), projectPath).then(async () => {
+      const packageJsonFile = join(projectPath, 'package.json');
+      const packageJson = JSON.parse(await readFileSync(packageJsonFile));
+      packageJson.name = projectName;
+      const writeJson = require('write-json');
+      writeJson.sync(packageJsonFile, packageJson);
+
+      baseComponentsToInstall.forEach((component) => {
+        cpSync(
+          join(__dirname, '..', 'livingdocs', ...component.split('/')),
+          join(projectPath, 'livingdocs', ...component.split('/')),
+          { recursive: true, force: true },
+        );
+      });
+
+      await writeFileSync(
+        `${projectPath}/.gitignore`,
+        `/.output/\n/.srl/\n/node_modules/\n/public/downloads/\n/public/html/\n/public/images/\n/public/json/\n/public/exclude/\n/dev-dist/`,
+      );
+      console.log(`Project has created`);
+      console.log(`cd ${folder}`);
+      console.log(`npm install`);
+    });
+  }
+}
+
+export { init };

package/scripts/ldd/LivingdocsDesignValidator.d.ts

@@ -0,0 +1,61 @@
+export default LivingdocsDesignValidator;
+export class LivingdocsDesignValidator {
+    /**
+     *
+     */
+    constructor(lddDesign: any);
+    lddDesign: any;
+    /**
+     *
+     * @returns {boolean} wether or not a design is valid
+     */
+    IsDesignValid(): boolean;
+    /**
+     * Test if all component properties are declared
+     * @returns {boolean}
+     */
+    usedPropertiesAreDeclared(): boolean;
+    /**
+     * Test if each components belong to at least one group
+     * @returns {boolean}
+     */
+    everyComponentHasAGroup(): boolean;
+    /**
+     * Test if there are any duplicate component names
+     * @returns {boolean}
+     */
+    hasNoDuplicateComponentNames(): boolean;
+    /**
+     * Test if there are any duplicate groups
+     * @returns {boolean}
+     */
+    hasNoDuplicateGroupLabels(): boolean;
+    /**
+     * Test if any component uses a declared property, log a warning if unused
+     * @returns {void}
+     */
+    allComponentPropertiesAreUsed(): void;
+    /**
+     * Test if every doc-directive and json declaration exist
+     * common user failures are:
+     * - duplicate directive value
+     * - diplicate usage of doc-link
+     * - declared but not used directive value
+     * - allowedChildren component/s do not exist
+     * - defaultContent component does not exist
+     * @returns {boolean}
+     */
+    everyDeclaredDirectiveExistsOnComponent(): boolean;
+    delcaredDirectivesExistsOnComponent(component: any): boolean;
+    /**
+     *
+     * @returns {boolean} true when parents exist
+     */
+    everyAllowedParentExistsInDesign(): boolean;
+    /**
+     * Test if referenced defaultContent and allowedChildren exist
+     * @param {object} directive
+     * @returns {boolean}
+     */
+    _checkContainerDirective(directive: object): boolean;
+}