avrotize 2.2.4__tar.gz → 2.3.0__tar.gz

{avrotize-2.2.4 → avrotize-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: avrotize
-Version: 2.2.4
+Version: 2.3.0
 Summary: Tools to convert from and to Avro Schema from various other schema languages.
 Author-email: Clemens Vasters <clemensv@microsoft.com>
 Requires-Python: >=3.10

{avrotize-2.2.4 → avrotize-2.3.0}/avrotize/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.2.4'
-__version_tuple__ = version_tuple = (2, 2, 4)
+__version__ = version = '2.3.0'
+__version_tuple__ = version_tuple = (2, 3, 0)

avrotize-2.3.0/avrotize/avrotots/class_core.ts.jinja

@@ -0,0 +1,114 @@
+/** {{ class_name }} class. */
+{%- if typed_json_annotation %}
+import 'reflect-metadata';
+import { jsonObject, jsonMember, TypedJSON } from 'typedjson';
+{%- endif %}
+{%- if avro_annotation %}
+import { Type } from 'avro-js';
+{%- endif %}
+{%- for import_type, import_path in import_types.items() %}
+import { {{ import_type }} } from '{{ import_path }}';
+{%- endfor %}
+{%- if avro_annotation or typed_json_annotation %}
+import pako from 'pako';
+{%- endif %}
+
+@jsonObject
+export class {{ class_name }} {
+    {%- if avro_annotation %}
+    public static AvroType: Type = Type.forSchema({{ avro_schema_json }});
+    {%- endif %}
+
+    {%- for field in fields %}
+    /** {{ field.docstring }} */
+    {%- if typed_json_annotation %}
+    @jsonMember
+    {%- endif %}
+    public {{ field.name }}: {{ field.type }};
+    {%- endfor %}
+
+    constructor({%- for field in fields %}{{ field.name }}: {{ field.type }}{%- if not loop.last %}, {%- endif %}{%- endfor %}) {
+        {%- for field in fields %}
+        {%- if field.is_enum %}
+        if ( typeof {{ field.name }} === 'number' ) {
+            this.{{ field.name }} = {{ field.type }}Utils.fromOrdinal({{ field.name }});
+        } else {
+            this.{{ field.name }} = {{ field.name }};
+        }
+        {%- else %}
+        this.{{ field.name }} = {{ field.name }};
+        {%- endif %}
+        {%- endfor %}
+    }
+
+    {%- if avro_annotation or typed_json_annotation %}
+    public toByteArray(contentTypeString: string): Uint8Array {
+        const contentType = contentTypeString.split(';')[0].trim();
+        let result: Uint8Array | null = null;
+
+        {%- if avro_annotation %}
+        if (contentType.startsWith('avro/binary') || contentType.startsWith('application/vnd.apache.avro+avro')) {
+            result = ({{ class_name }}.AvroType.toBuffer(this) as unknown) as Uint8Array;
+        }
+        {%- endif %}
+
+        {%- if typed_json_annotation %}
+        if (contentType.startsWith('application/json')) {
+            const serializer = new TypedJSON({{ class_name }});
+            const jsonString = serializer.stringify(this);
+            result = new TextEncoder().encode(jsonString);
+        }
+        {%- endif %}
+
+        if (result && contentTypeString.endsWith('+gzip')) {
+            result = pako.gzip(result);
+        }
+
+        if (result) {
+            return result;
+        } else {
+            throw new Error(`Unsupported media type: ${contentTypeString}`);
+        }
+    }
+
+    public static fromData(data: any, contentTypeString: string): {{ class_name }} {
+        const contentType = contentTypeString.split(';')[0].trim();
+
+        if (contentTypeString.endsWith('+gzip')) {
+            data = pako.ungzip(data);
+        }
+
+        {%- if avro_annotation %}
+        if (contentType.startsWith('avro/binary') || contentType.startsWith('application/vnd.apache.avro+avro')) {
+            return {{ class_name }}.AvroType.fromBuffer(data);
+        }
+        {%- endif %}
+
+        {%- if typed_json_annotation %}
+        if (contentType.startsWith('application/json')) {
+            const serializer = new TypedJSON({{ class_name }});
+            const retval = serializer.parse(new TextDecoder().decode(data));
+            if (!(retval instanceof {{ class_name }})) {
+                throw new Error(`Deserialized object is not an instance of {{ class_name }}`);
+            }
+            return retval;
+        }
+        {%- endif %}
+
+        throw new Error(`Unsupported media type: ${contentTypeString}`);
+    }
+
+    public static isJsonMatch(element: any): boolean {
+        {%- if fields|length == 0 %}
+        return true;
+        {%- else %}
+        return (
+            {%- for field in fields %}
+            {{ get_is_json_match_clause(field.name, field.type, field.is_enum) }}{%- if not loop.last %} &&
+            {%- endif %}
+            {%- endfor %}
+        );
+        {%- endif %}
+    }
+    {%- endif %}
+}

avrotize-2.3.0/avrotize/avrotots/enum_core.ts.jinja

@@ -0,0 +1,40 @@
+/** {{ enum_name }} enum. */
+export enum {{ enum_name }} {
+    {%- for symbol in symbols %}
+    {{ symbol }} = "{{ symbol }}"{%- if not loop.last %},{%- endif %}
+    {%- endfor %}
+}
+
+export class {{ enum_name }}Utils {
+    /**
+    * Converts a {{ enum_name }} enum value to its ordinal.
+    * @param value - The {{ enum_name }} enum value ({{ symbols|join(', ') }}).
+    * @returns The ordinal number corresponding to the enum value.
+    */
+    static toOrdinal(value: {{ enum_name }}): number {
+        switch (value) {
+            {%- for symbol in symbols %}
+            case {{ enum_name }}.{{ symbol }}:
+                return {{ loop.index0 }};
+            {%- endfor %}
+            default:
+                throw new Error("Invalid {{ enum_name }} value");
+        }
+    }
+
+    /**
+    * Converts an ordinal to its corresponding {{ enum_name }} enum value.
+    * @param ordinal - The ordinal number of the enum value.
+    * @returns The corresponding {{ enum_name }} enum value.
+    */
+    static fromOrdinal(ordinal: number): {{ enum_name }} {
+        switch (ordinal) {
+            {%- for symbol in symbols %}
+            case {{ loop.index0 }}:
+                return {{ enum_name }}.{{ symbol }};
+            {%- endfor %}
+            default:
+                throw new Error("Invalid ordinal value");
+        }
+    }
+}

avrotize-2.3.0/avrotize/avrotots/gitignore.jinja

@@ -0,0 +1,34 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# Build output
+dist/

avrotize-2.3.0/avrotize/avrotots/package.json.jinja

@@ -0,0 +1,23 @@
+{
+    "name": "{{ package_name }}",
+    "version": "1.0.0",
+    "description": "Generated TypeScript classes from Avro schema",
+    "main": "dist/index.js",
+    "type": "module",
+    "scripts": {
+        "build": "tsc",
+        "start": "node dist/index.js"
+    },
+    "dependencies": {
+        "avro-js": "^1.12.0",
+        "typedjson": "^1.8.0",
+        "pako": "^2.1.0",
+        "reflect-metadata": "^0.2.2",
+        "@types/pako": "^2.0.3"
+    },
+    "devDependencies": {
+        "typescript": "^5.4.5"
+    },
+    "author": "",
+    "license": "ISC"
+}

avrotize-2.3.0/avrotize/avrotots/tsconfig.json.jinja

@@ -0,0 +1,21 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "ES2022",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "outDir": "./dist",
+        "rootDir": "./src",
+        "experimentalDecorators": true,
+        "emitDecoratorMetadata": true,
+        "declaration": true,
+        "declarationMap": true,
+        "moduleResolution": "node",
+        "resolveJsonModule": true
+    },
+    "include": [
+        "src/**/*"
+    ]
+}