update types

Author: nytamin

v1-draft-0/typescript-definitions/README.md

@@ -1,6 +1,68 @@
 # OGraf Typescript Definitions
 
-_This definition is intended to be derived from the Source Definitions_
+These are Typescript definitions for the OGraf API.
+
+https://github.com/ebu/ograf
+
+## Getting Started
+
+```typescript
+
+import { GraphicsAPI } from 'ograf';
+
+
+// Setup my OGraf graphic WebComponent:
+class MyOGrafGraphic extends HTMLElement implements GraphicsAPI.Graphic {
+    connectedCallback() {
+        // Called when the element is added to the DOM
+        // Note: Don't paint any pixels at this point, wait for load() to be called
+    }
+
+    async load(params) {
+        if (params.renderType !== "realtime")
+        throw new Error("Only realtime rendering is supported by this graphic");
+
+        const elText = document.createElement("p");
+        elText.innerHTML = "Hello world!";
+        this.appendChild(elText);
+
+        // When everything is loaded we can return:
+        return {
+        statusCode: 200,
+        };
+    }
+    async dispose(_params) {
+        this.innerHTML = "";
+    }
+    async getStatus(_params) {
+        return {
+        statusCode: 200,
+        status: {
+            // nothing
+        },
+        };
+    }
+    async updateAction(_params) {
+        // No actions are implemented in this minimal example
+    }
+    async playAction(_params) {
+        // No actions are implemented in this minimal example
+    }
+    async stopAction(_params) {
+        // No actions are implemented in this minimal example
+    }
+    async customAction(params) {
+        // No actions are implemented in this minimal example
+    }
+    async goToTime(_payload) {
+        throw new Error("Non-realtime not supported!");
+    }
+    async setActionsSchedule(_payload) {
+        throw new Error("Non-realtime not supported!");
+    }
+}
+
+```
 
 
 ## For Developers

v1-draft-0/typescript-definitions/package-lock.json

@@ -1,12 +1,24 @@
 {
-  "name": "html-graphics-definition",
-  "version": "0.0.0",
+  "name": "ograf",
+  "version": "0.0.1",
   "main": "dist/main.js",
+  "typings": "dist/index.d.ts",
   "license": "MIT",
+  "description": "TypeScript definitions for Ograf graphics",
+  "homepage": "https://github.com/ebu/ograf",
+  "keywords": [
+    "ograf",
+    "types",
+    "typescript",
+    "ebu",
+    "broadcast",
+    "graphics"
+  ],
   "scripts": {
     "build": "tsc --build",
     "watch": "tsc --watch",
-    "generate-types": "node scripts/generate-types.js"
+    "generate-types": "node scripts/generate-types.js",
+    "do:publish": "npm run generate-types && npm run build && npm publish --access public"
   },
   "devDependencies": {
     "typescript": "^5.6.3",

v1-draft-0/typescript-definitions/package.json

@@ -3,6 +3,8 @@ const path = require("path");
 const fs = require("fs");
 
 async function main() {
+
+
   const outputPath = path.resolve("./src/generated");
   const schemaPath = path.resolve("../specification/json-schemas/graphics");
   const options = {

v1-draft-0/typescript-definitions/scripts/generate-types.js

@@ -15,9 +15,11 @@ import {
  */
 
 /**
- * Methods called on a GraphicInstance by the Renderer
+ * This interface defines the methods that the Renderer can call on the Graphic.
+ * @example class MyOGrafGraphic extends HTMLElement implements GraphicsAPI.Graphic {}
+ *
  */
-export interface GraphicsApi {
+export interface Graphic {
   /**
    * Called by the Renderer when the Graphic has been loaded into the DOM
    * @returns a Promise that resolves when the Graphic has finished loading it's resources.
@@ -90,19 +92,19 @@ export interface GraphicsApi {
         action:
           | ({
               type: "updateAction";
-              params: Parameters<GraphicsApi["updateAction"]>[0];
+              params: Parameters<Graphic["updateAction"]>[0];
             } & VendorExtend)
           | ({
               type: "playAction";
-              params: Parameters<GraphicsApi["playAction"]>[0];
+              params: Parameters<Graphic["playAction"]>[0];
             } & VendorExtend)
           | ({
               type: "stopAction";
-              params: Parameters<GraphicsApi["stopAction"]>[0];
+              params: Parameters<Graphic["stopAction"]>[0];
             } & VendorExtend)
           | ({
               type: "customAction";
-              params: Parameters<GraphicsApi["customAction"]>[0];
+              params: Parameters<Graphic["customAction"]>[0];
             } & VendorExtend);
       }[];
     } & VendorExtend