feat(ontology-find-icon-helper): add package

packages/OntologyService/__tests__/OntologyService.jena_integration.test.ts

@@ -254,13 +254,13 @@ describe("OntologyService - Integration Test with Fuseki - Create Data", () => {
   });
 
   it("should retrieve all styles if an empty array is passed in", async () => {
-    const styles = await os.getFlattenedStyles([]);
+    const styles = await os.PROPOSED_getFlattenedStyles([]);
     expect(styles.length).toEqual(3);
   });
 
   it("should retrieve the icon for the target uri", async () => {
-    const styles = await os.getFlattenedStyles([]);
-    const icon = os.findIcon(
+    const styles = await os.PROPOSED_getFlattenedStyles([]);
+    const icon = os.PROPOSED_findIcon(
       styles,
       "http://ies.data.gov.uk/ontology/ies4#Accent",
     );
@@ -278,8 +278,8 @@ describe("OntologyService - Integration Test with Fuseki - Create Data", () => {
   });
 
   it("should retrieve fallback text and colours if the targeturi does not exist", async () => {
-    const styles = await os.getFlattenedStyles([]);
-    const icon = os.findIcon(
+    const styles = await os.PROPOSED_getFlattenedStyles([]);
+    const icon = os.PROPOSED_findIcon(
       styles,
       "http://ies.data.gov.uk/ontology/ies4#IDontExist",
     );
@@ -294,8 +294,8 @@ describe("OntologyService - Integration Test with Fuseki - Create Data", () => {
   });
 
   it("should handle an incorrect uri without crashing the app", async () => {
-    const styles = await os.getFlattenedStyles([]);
-    const icon = os.findIcon(
+    const styles = await os.PROPOSED_getFlattenedStyles([]);
+    const icon = os.PROPOSED_findIcon(
       styles,
       "InvalidUrl",
     );

packages/OntologyService/index.ts

@@ -99,6 +99,7 @@ export const FlattenedStyle = z.object({
 
 export type FlattenedStyleType = z.infer<typeof FlattenedStyle>;
 
+export type FlattenedStyleTypeForFindIcon = Omit<FlattenedStyleType, "shape" | "faUnicode" | "faIcon">;
 export const IconStyle = z.object({
   classUri: z.string(),
   backgroundColor: z.string(),
@@ -110,6 +111,7 @@ export const IconStyle = z.object({
   faUnicode: z.string().optional(),
   shape: z.string().optional(),
 });
+export type IconStyleType = z.infer<typeof IconStyle>;
 
 export const IconStyleArray = z.array(IconStyle);
 
@@ -1403,7 +1405,7 @@ export class OntologyService extends RdfService {
   }
 
   // DS specific methods
-  async getFlattenedStyles(classes: LongURI[]) {
+  async PROPOSED_getFlattenedStyles(classes: LongURI[]) {
     const styles = await this.getStyles(classes);
     return Object.entries(styles).map(([classUri, style]) => {
       return ({
@@ -1419,7 +1421,7 @@ export class OntologyService extends RdfService {
     });
   }
 
-  findIcon(styles: FlattenedStyleType[], classUri: LongURI) {
+  PROPOSED_findIcon(styles: FlattenedStyleType[], classUri: LongURI) {
     const foundIcon = styles.find((style) => style.classUri === classUri);
 
     if (foundIcon) return foundIcon;

packages/RdfService/schema.test.ts

@@ -0,0 +1,42 @@
+import { URISegmentOrHashSchema } from "./schema";
+
+test("Fail when input is not a uri", () => {
+  expect(() => URISegmentOrHashSchema.parse("abd"))
+    .toThrowErrorMatchingInlineSnapshot(`
+    "[
+      {
+        "validation": "regex",
+        "code": "invalid_string",
+        "message": "\\n  Invalid URI format. \\n  Ensure it starts with a valid scheme and is followed by '://',\\n  then a valid resource part without spaces.",
+        "path": []
+      },
+      {
+        "code": "custom",
+        "message": "URI must include either a hash or at least one URI segment.",
+        "path": []
+      }
+    ]"
+  `);
+});
+test("Fail when input is uri without hash or url segment", () => {
+  expect(() => URISegmentOrHashSchema.parse("http://example.com"))
+    .toThrowErrorMatchingInlineSnapshot(`
+    "[
+      {
+        "code": "custom",
+        "message": "URI must include either a hash or at least one URI segment.",
+        "path": []
+      }
+    ]"
+  `);
+});
+test("Pass when input is uri with hash", () => {
+  expect(() =>
+    URISegmentOrHashSchema.parse("http://example.com#blah")
+  ).not.toThrow();
+});
+test("Pass when input is uri with url segment", () => {
+  expect(() =>
+    URISegmentOrHashSchema.parse("http://example.com/blah")
+  ).not.toThrow();
+});

packages/RdfService/schema.ts

@@ -1,5 +1,32 @@
 import z from 'zod';
-import { isValidURI } from './isValidURI';
+import { isValidURI, permissiveUriRegex } from './isValidURI';
+
+
+/**
+ * RE: Name "URISegmentOrHashSchema"
+ * the requirement for a url segment or a hash is likely mentioned
+ * in specs - I prefer naming it literally for readability and grepping
+ */
+export const URISegmentOrHashSchema = z.string().regex(permissiveUriRegex, {
+  message: `
+  Invalid URI format. 
+  Ensure it starts with a valid scheme and is followed by '://',
+  then a valid resource part without spaces.`,
+}).refine(value => {
+  try {
+    const url = new URL(value);
+    // Check for hash or at least one path segment
+    return url.hash !== '' || (url.pathname !== '/' && url.pathname !== '');
+  } catch {
+    return false;
+  }
+}, {
+  message: "URI must include either a hash or at least one URI segment."
+});
+
+
+
+
 
 
 // Schema for the object representing "o", "p", or "s" within each triple

packages/RdfService/types.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
-import { RDFSchema, RDFTripleSchema } from './schema';
+import { RDFSchema, RDFTripleSchema, URISegmentOrHashSchema } from './schema';
 
 // Schema for the RDF triple
 export type RDFTripleType = z.infer<typeof RDFTripleSchema>;
 export type RDFType = z.infer<typeof RDFSchema>;
+export type URISegmentOrHashType = z.infer<typeof URISegmentOrHashSchema>; // Lossy type

packages/ontology-find-icon-helper/.eslintrc.cjs

@@ -0,0 +1,24 @@
+module.exports =  {
+  plugins: [
+    "@typescript-eslint/eslint-plugin",
+    "eslint-plugin-tsdoc"
+  ],
+  extends:  [
+    'plugin:@typescript-eslint/recommended'
+  ],
+  ignorePatterns: ["dist/"],
+  parser:  '@typescript-eslint/parser',
+  parserOptions: {
+    project: "./tsconfig.json",
+    tsconfigRootDir: __dirname,
+    ecmaVersion: 2018,
+    sourceType: "module"
+  },
+  rules: {
+    "tsdoc/syntax": "warn",
+    "@typescript-eslint/no-floating-promises": ["error", {
+      "ignoreVoid": false,
+      "ignoreIIFE": false
+    }]
+  }
+};

packages/ontology-find-icon-helper/.nvmrc

@@ -0,0 +1 @@
+20.14.0

packages/ontology-find-icon-helper/README.md

@@ -0,0 +1,48 @@
+# @telicent-oss/ontology-find-icon-helper
+
+*Monorepo Location: `./packages/ontology-find-icon-helper`*
+
+A helper for frontend apps to load and access ontology icons from ontology styles
+
+### Install
+
+```bash
+yarn install @telicent-oss/ontology-find-icon-helper
+```
+
+### Usage
+
+```ts
+import { OntologyFindIconHelper } from "@company-oss/ontology-find-icon-helper";
+
+// Initialize the CatalogService
+const catalogService = await CatalogService.createAsync({
+  writeEnabled: true,
+  triplestoreUri: "http://localhost:3030",
+  dataset: "dataset",
+});
+
+// Create Catalog
+const catalog1 = await DCATCatalog.createAsync(
+  catalogService,
+  "http://mysche.ma/data/catalog1",
+  "Catalog",
+  "2023-01-01"
+);
+```
+
+## Development
+
+### Build
+
+```bash
+git clone https://github.com/Telicent-oss/rdf-libraries
+cd rdf-libraries
+yarn install
+cd /packages/ontology-find-icon-helper
+# make changes
+npx nx affected:build
+```
+
+* [./packages/OntologyService](https://github.com/telicent-oss/rdf-libraries/tree/main/packages/OntologyService) - consumes to get ontology styles (and icons)f
+

packages/ontology-find-icon-helper/jest.config.js

@@ -0,0 +1,15 @@
+/* eslint-disable */
+export default {
+  displayName: "@telicent-oss/ontology-find-icon-helper",
+  preset: "../../jest.preset.js",
+  coverageDirectory: "../../coverage/packages/ontology-find-icon-helper",
+  automock: false,
+  setupFiles: ["./setupTests.ts"],
+  globals: {
+    "ts-jest": {
+      tsconfig: {
+        tsconfig: "./tsconfig.spec.json",
+      },
+    },
+  },
+};

packages/ontology-find-icon-helper/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@telicent-oss/ontology-find-icon-helper",
+  "version": "0.0.1",
+  "private": false,
+  "description": "Simple client-side library retrieving and accessing ontology style/icon objects.",
+  "main": "./dist/ontology-find-icon-helper.js",
+  "module": "./dist/ontology-find-icon-helper.js",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/ontology-find-icon-helper.js",
+      "require": "./dist/ontology-find-icon-helper.umd.js",
+      "types": "./dist/types.d.ts"
+    },
+    "./index": {
+      "import": "./dist/ontology-find-icon-helper.js",
+      "require": "./dist/ontology-find-icon-helper.umd.cjs",
+      "types": "./dist/types.d.ts"
+    }
+  },
+  "types": "./dist/types.d.ts",
+  "scripts": {
+    "test": "jest --runInBand ",
+    "build": "rm -rf ./dist && vite build",
+    "lint": "eslint **/*.ts"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/telicent-oss/rdf-libraries.git"
+  },
+  "publishConfig": {
+    "registry": "https://www.npmjs.com/"
+  },
+  "dependencies": {
+    "@telicent-oss/ontologyservice": "*",
+    "lodash.startcase": "^4.4.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.4.0",
+    "@types/lodash.startcase": "^4.4.9",
+    "@types/node": "16.11.7",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "tsc": "^2.0.4",
+    "typescript": "^5.5.4",
+    "vite": "^4.5.3",
+    "vite-plugin-dts": "^3.6.3",
+    "vite-tsconfig-paths": "^4.2.1"
+  },
+  "engines": {
+    "node": ">=20.14.0"
+  },
+  "resolutions": {
+    "rollup": "3.29.5"
+  }
+}

packages/ontology-find-icon-helper/project.json

@@ -0,0 +1,25 @@
+{
+  "name": "@telicent-oss/ontology-find-icon-helper",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "targets": {
+    "test": {
+      "executor": "nx:run-commands",
+      "options": {
+        "commands": [
+          {
+            "command": "yarn test"
+          }
+        ],
+        "cwd": "packages/ontology-find-icon-helper",
+        "parallel": false
+      }
+    },
+    "printhello": {
+      "executor": "nx:run-commands",
+      "outputs": [],
+      "options": {
+        "command": "echo hello"
+      }
+    }
+  }
+}