@platforma-sdk/tengo-builder 2.0.3 → 2.1.0

package/src/compiler/template.ts

@@ -7,49 +7,96 @@ import {
   fullNameWithoutTypeToString,
   parseArtefactNameAndVersion,
 } from './package';
-import type { TemplateData } from '@milaboratories/pl-model-backend';
+import type { CompiledTemplateV3 } from '@milaboratories/pl-model-backend';
 import {
   parseTemplate,
   serializeTemplate,
 } from '@milaboratories/pl-model-backend';
 
-export class Template {
-  public readonly data: TemplateData;
-  public readonly content: Uint8Array;
-
-  constructor(
-    public readonly compileMode: CompileMode,
-    public readonly fullName: FullArtifactName,
-    body: {
-      data?: TemplateData;
-      content?: Uint8Array;
-    },
-  ) {
-    let { data, content } = body;
-    if (data === undefined && content === undefined)
-      throw new Error('Neither data nor content is provided for template constructor');
-    if (data !== undefined && content !== undefined)
-      throw new Error('Both data and content are provided for template constructor');
-
-    if (data === undefined) data = parseTemplate(content!);
-    if (content === undefined) content = serializeTemplate(data);
-
-    const nameFromData: FullArtifactNameWithoutType = parseArtefactNameAndVersion(data);
-
-    if (
-      nameFromData.pkg !== fullName.pkg
-      || nameFromData.id !== fullName.id
-      || nameFromData.version !== fullName.version
-    )
-      throw new Error(
-        `Compiled template name don't match it's package and file names: ${fullNameWithoutTypeToString(nameFromData)} != ${fullNameWithoutTypeToString(fullName)}`,
-      );
-
-    this.data = data;
-    this.content = content;
-  }
+/** Just a holder for template data, compilation options, full name and source code.
+ * It mimics ArtifactSource interface.
+ */
+export type TemplateWithSource = {
+  readonly compileMode: CompileMode;
+  readonly fullName: FullArtifactName;
+  readonly source: string;
+  readonly data: CompiledTemplateV3;
+};
+
+export function newTemplateWithSource(
+  compileMode: CompileMode,
+  fullName: FullArtifactName,
+  data: CompiledTemplateV3,
+  source: string,
+): TemplateWithSource {
+  validateTemplateName(fullName, data);
+
+  return {
+    compileMode,
+    fullName,
+    data,
+    source,
+  };
+}
+
+export type Template = {
+  readonly compileMode: CompileMode;
+  readonly fullName: FullArtifactName;
+  readonly data: CompiledTemplateV3;
+  readonly content: Uint8Array;
+};
+
+export function newTemplateFromData(
+  compileMode: CompileMode,
+  fullName: FullArtifactName,
+  data: CompiledTemplateV3,
+): Template {
+  validateTemplateName(fullName, data);
+  return {
+    compileMode,
+    fullName,
+    data,
+    content: serializeTemplate(data),
+  };
+}
 
-  toJSON() {
-    return { compileMode: this.compileMode, fullName: this.fullName, data: this.data };
+export function newTemplateFromContent(
+  compileMode: CompileMode,
+  fullName: FullArtifactName,
+  content: Uint8Array,
+): Template {
+  const data = parseTemplate(content);
+  if (data.type !== 'pl.tengo-template.v3') {
+    throw new Error('malformed v3 template');
   }
+
+  validateTemplateName(fullName, data);
+  return {
+    compileMode,
+    fullName,
+    data,
+    content,
+  };
+}
+
+export function templateToSource(tpl: Template): TemplateWithSource {
+  return {
+    compileMode: tpl.compileMode,
+    fullName: tpl.fullName,
+    data: tpl.data,
+    source: tpl.data.hashToSource[tpl.data.template.sourceHash],
+  };
+}
+function validateTemplateName(fullName: FullArtifactName, data: CompiledTemplateV3) {
+  const nameFromData: FullArtifactNameWithoutType = parseArtefactNameAndVersion(data.template);
+
+  if (
+    nameFromData.pkg !== fullName.pkg
+    || nameFromData.id !== fullName.id
+    || nameFromData.version !== fullName.version
+  )
+    throw new Error(
+      `Compiled template name don't match it's package and file names: `
+      + `${fullNameWithoutTypeToString(nameFromData)} != ${fullNameWithoutTypeToString(fullName)}`,
+    );
 }

package/src/compiler/test.artifacts.ts

@@ -202,6 +202,16 @@ export const testPackage1Soft1Src = `
 some software contents. Template builder should pass it 'as-is'
 `;
 
+export const testPackage1Asset1Name: FullArtifactName = {
+  type: 'asset',
+  pkg: 'current-package',
+  id: 'asset-1',
+  version: '1.2.3',
+};
+export const testPackage1Asset1Src = `
+some asset contents. Template builder should pass it 'as-is'
+`;
+
 export const testPackage1Lib2Name: FullArtifactName = {
   type: 'library',
   pkg: 'package1',