@fedify/fedify@1.3.3

Built and signed on GitHub Actions

Built and signed on GitHub Actions

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
import metadata from "../deno.json" with { type: "json" };
import { generateField, getFieldName } from "./field.ts";
import type { TypeSchema } from "./schema.ts";
import {
  areAllScalarTypes,
  emitOverride,
  getAllProperties,
  getDecoder,
  getDecoders,
  getEncoders,
  getSubtypes,
  isCompactableType,
} from "./type.ts";

export async function* generateEncoder(
  typeUri: string,
  types: Record<string, TypeSchema>,
): AsyncIterable<string> {
  const type = types[typeUri];
  yield `
  /**
   * Converts this object to a JSON-LD structure.
   * @param options The options to use.
   *                - \`format\`: The format of the output: \`compact\` or
                      \`expand\`.
   *                - \`contextLoader\`: The loader for remote JSON-LD contexts.
   *                - \`context\`: The JSON-LD context to use.  Not applicable
                      when \`format\` is set to \`'expand'\`.
   * @returns The JSON-LD representation of this object.
   */
  ${emitOverride(typeUri, types)} async toJsonLd(options: {
    format?: "compact" | "expand",
    contextLoader?: DocumentLoader,
    context?: string | Record<string, string> | (string | Record<string, string>)[],
  } = {}): Promise<unknown> {
    if (options.format == null && this._cachedJsonLd != null) {
      return this._cachedJsonLd;
    }
    if (options.format !== "compact" && options.context != null) {
      throw new TypeError(
        "The context option can only be used when the format option is set " +
        "to 'compact'."
      );
    }
    options = {
      ...options,
      contextLoader: options.contextLoader ?? getDocumentLoader(),
    };
  `;
  if (isCompactableType(typeUri, types)) {
    yield `
    if (options.format == null && this.isCompactable()) {
    `;
    if (type.extends == null) {
      yield "const result: Record<string, unknown> = {};";
    } else {
      yield `
      const result = await super.toJsonLd({
        ...options,
        format: undefined,
        context: undefined,
      }) as Record<string, unknown>;
      `;
      const selfProperties = type.properties.map((p) => p.uri);
      for (const property of getAllProperties(typeUri, types, true)) {
        if (!selfProperties.includes(property.uri)) continue;
        yield `delete result[${JSON.stringify(property.compactName)}];`;
      }
    }
    yield `
      // deno-lint-ignore no-unused-vars
      let compactItems: unknown[];
    `;
    for (const property of type.properties) {
      yield `
      compactItems = [];
      for (const v of this.${await getFieldName(property.uri)}) {
        const item = (
      `;
      if (!areAllScalarTypes(property.range, types)) {
        yield "v instanceof URL ? v.href : ";
      }
      const encoders = getEncoders(
        property.range,
        types,
        "v",
        "options",
        true,
      );
      for (const code of encoders) yield code;
      yield `
        );
        compactItems.push(item);
      }
      if (compactItems.length > 0) {
      `;
      if (property.functional || property.container !== "list") {
        yield `
        result[${JSON.stringify(property.compactName)}]
          = compactItems.length > 1
          ? compactItems
          : compactItems[0];
        `;
        if (property.functional && property.redundantProperties != null) {
          for (const prop of property.redundantProperties) {
            yield `
            result[${JSON.stringify(prop.compactName)}]
              = compactItems.length > 1
              ? compactItems
              : compactItems[0];
            `;
          }
        }
      } else {
        yield `
        result[${JSON.stringify(property.compactName)}] = compactItems;
        `;
      }
      yield `
      }
      `;
    }
    yield `
      result["type"] = ${JSON.stringify(type.compactName ?? type.uri)};
      if (this.id != null) result["id"] = this.id.href;
      result["@context"] = ${JSON.stringify(type.defaultContext)};
      return result;
    }
    `;
  }
  yield `
    // deno-lint-ignore no-unused-vars prefer-const
    let array: unknown[];
  `;
  if (type.extends == null) {
    yield "const values: Record<string, unknown[] | string> = {};";
  } else {
    yield `
    const baseValues = await super.toJsonLd({
      ...options,
      format: "expand",
      context: undefined,
    }) as unknown[];
    const values = baseValues[0] as Record<
      string,
      unknown[] | { "@list": unknown[] } | string
    >;
    `;
  }
  for (const property of type.properties) {
    yield `
    array = [];
    for (const v of this.${await getFieldName(property.uri)}) {
      const element = (
    `;
    if (!areAllScalarTypes(property.range, types)) {
      yield 'v instanceof URL ? { "@id": v.href } : ';
    }
    for (const code of getEncoders(property.range, types, "v", "options")) {
      yield code;
    }
    yield `
      );
    `;
    if (!property.functional && property.container === "graph") {
      yield `array.push({ "@graph": element });`;
    } else {
      yield `array.push(element);`;
    }
    yield `;
    }
    if (array.length > 0) {
      const propValue = (
    `;
    if (!property.functional && property.container === "list") {
      yield `{ "@list": array }`;
    } else {
      yield `array`;
    }
    yield `
      );
      values[${JSON.stringify(property.uri)}] = propValue;
    `;
    if (property.functional && property.redundantProperties != null) {
      for (const prop of property.redundantProperties) {
        yield `
        values[${JSON.stringify(prop.uri)}] = propValue;
        `;
      }
    }
    yield `
    }
    `;
  }
  yield `
    values["@type"] = [${JSON.stringify(type.uri)}];
    if (this.id != null) values["@id"] = this.id.href;
    if (options.format === "expand") {
      return await jsonld.expand(
        values,
        { documentLoader: options.contextLoader },
      );
    }
    const docContext = options.context ??
      ${JSON.stringify(type.defaultContext)};
    const compacted = await jsonld.compact(
      values,
      docContext,
      { documentLoader: options.contextLoader },
    );
    if (docContext != null) {
      // Embed context
  `;
  const supertypes: string[] = [];
  for (
    let uri: string | undefined = typeUri;
    uri != null;
    uri = types[uri].extends
  ) {
    supertypes.push(uri);
  }
  for (const supertype of supertypes) {
    for (const property of types[supertype].properties) {
      if (property.embedContext == null) continue;
      const compactName = property.embedContext.compactName;
      yield `
      if (${JSON.stringify(compactName)} in compacted &&
          compacted.${compactName} != null) {
        if (Array.isArray(compacted.${compactName})) {
          for (const element of compacted.${compactName}) {
            element["@context"] = docContext;
          }
        } else {
         compacted.${compactName}["@context"] = docContext;
        }
      }
      `;
    }
  }
  yield `
    }
    return compacted;
  }

  protected ${emitOverride(typeUri, types)} isCompactable(): boolean {
`;
  for (const property of type.properties) {
    if (!property.range.every((r) => isCompactableType(r, types))) {
      yield `
      if (
        this.${await getFieldName(property.uri)} != null &&
        this.${await getFieldName(property.uri)}.length > 0
      ) return false;
      `;
    }
  }
  yield `
    return ${type.extends == null ? "true" : "super.isCompactable()"};
  }
  `;
}

export async function* generateDecoder(
  typeUri: string,
  types: Record<string, TypeSchema>,
): AsyncIterable<string> {
  const type = types[typeUri];
  yield `
  /**
   * Converts a JSON-LD structure to an object of this type.
   * @param json The JSON-LD structure to convert.
   * @param options The options to use.
   *                - \`documentLoader\`: The loader for remote JSON-LD documents.
   *                - \`contextLoader\`: The loader for remote JSON-LD contexts.
   *                - \`tracerProvider\`: The OpenTelemetry tracer provider to use.
   *                  If omitted, the global tracer provider is used.
   * @returns The object of this type.
   * @throws {TypeError} If the given \`json\` is invalid.
   */
  static ${emitOverride(typeUri, types)} async fromJsonLd(
    json: unknown,
    options: {
      documentLoader?: DocumentLoader,
      contextLoader?: DocumentLoader,
      tracerProvider?: TracerProvider,
    } = {},
  ): Promise<${type.name}> {
    const tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
    const tracer = tracerProvider.getTracer(
      ${JSON.stringify(metadata.name)},
      ${JSON.stringify(metadata.version)},
    );
    return await tracer.startActiveSpan(
      "activitypub.parse_object",
      async (span) => {
        try {
          const object = await this.__fromJsonLd__${type.name}__(
            json, span, options);
          if (object.id != null) {
            span.setAttribute("activitypub.object.id", object.id.href);
          }
          return object;
        } catch (error) {
          span.setStatus({
            code: SpanStatusCode.ERROR,
            message: String(error),
          });
          throw error;
        } finally {
          span.end();
        }
      },
    );
  }

  protected static async __fromJsonLd__${type.name}__(
    json: unknown,
    span: Span,
    options: {
      documentLoader?: DocumentLoader,
      contextLoader?: DocumentLoader,
      tracerProvider?: TracerProvider,
    } = {},
  ): Promise<${type.name}> {
    if (typeof json === "undefined") {
      throw new TypeError("Invalid JSON-LD: undefined.");
    }
    else if (json === null) throw new TypeError("Invalid JSON-LD: null.");
    options = {
      ...options,
      documentLoader: options.documentLoader ?? getDocumentLoader(),
      contextLoader: options.contextLoader ?? getDocumentLoader(),
      tracerProvider: options.tracerProvider ?? trace.getTracerProvider(),
    };
    // deno-lint-ignore no-explicit-any
    let values: Record<string, any[]> & { "@id"?: string };
    if (globalThis.Object.keys(json).length == 0) {
      values = {};
    } else {
      const expanded = await jsonld.expand(json, {
        documentLoader: options.contextLoader,
        keepFreeFloatingNodes: true,
      });
      values =
        // deno-lint-ignore no-explicit-any
        (expanded[0] ?? {}) as (Record<string, any[]> & { "@id"?: string });
    }
  `;
  const subtypes = getSubtypes(typeUri, types, true);
  yield `
  if ("@type" in values) {
    span.setAttribute("activitypub.object.type", values["@type"]);
  }
  if ("@type" in values &&
      !values["@type"].every(t => t.startsWith("_:"))) {
  `;
  for (const subtypeUri of subtypes) {
    yield `
    if (values["@type"].includes(${JSON.stringify(subtypeUri)})) {
      return await ${types[subtypeUri].name}.fromJsonLd(json, options);
    }
    `;
  }
  yield `
    if (!values["@type"].includes(${JSON.stringify(typeUri)})) {
      throw new TypeError("Invalid type: " + values["@type"]);
    }
  }
  `;
  if (type.extends == null) {
    yield `
    const instance = new this(
      { id: "@id" in values ? new URL(values["@id"] as string) : undefined },
      options,
    );
    `;
  } else {
    yield `
    delete values["@type"];
    const instance = await super.fromJsonLd(values, {
      ...options,
      // @ts-ignore: an internal option
      _fromSubclass: true,
    });
    if (!(instance instanceof ${type.name})) {
      throw new TypeError("Unexpected type: " + instance.constructor.name);
    }
    `;
  }
  for (const property of type.properties) {
    const variable = await getFieldName(property.uri, "");
    yield await generateField(property, types, "const ");
    const arrayVariable = `${variable}__array`;
    yield `
    let ${arrayVariable} = values[${JSON.stringify(property.uri)}];
    `;
    if (property.functional && property.redundantProperties != null) {
      for (const prop of property.redundantProperties) {
        yield `
        if (${arrayVariable} == null || ${arrayVariable}.length < 1) {
          ${arrayVariable} = values[${JSON.stringify(prop.uri)}];
        }
        `;
      }
    }
    yield `
    for (
      const v of ${arrayVariable} == null
        ? []
        : ${arrayVariable}.length === 1 && "@list" in ${arrayVariable}[0]
        ? ${arrayVariable}[0]["@list"]
        : ${arrayVariable}
    ) {
      if (v == null) continue;
    `;
    if (!areAllScalarTypes(property.range, types)) {
      yield `
      if (typeof v === "object" && "@id" in v && !("@type" in v)
          && globalThis.Object.keys(v).length === 1) {
        ${variable}.push(
          !URL.canParse(v["@id"]) && v["@id"].startsWith("at://")
            ? new URL("at://" + encodeURIComponent(v["@id"].substring(5)))
            : new URL(v["@id"])
        );
        continue;
      }
      `;
    }
    if (property.range.length == 1) {
      yield `${variable}.push(${
        getDecoder(property.range[0], types, "v", "options")
      })`;
    } else {
      yield `
      const decoded =
      `;
      for (const code of getDecoders(property.range, types, "v", "options")) {
        yield code;
      }
      yield `
      ;
      if (typeof decoded === "undefined") continue;
      ${variable}.push(decoded);
      `;
    }
    yield `
    }
    instance.${await getFieldName(property.uri)} = ${variable};
    `;
  }
  yield `
    if (!("_fromSubclass" in options) || !options._fromSubclass) {
      try {
        instance._cachedJsonLd = structuredClone(json);
      } catch {
        getLogger(["fedify", "vocab"]).warn(
          "Failed to cache JSON-LD: {json}",
          { json },
        );
      }
    }
    return instance;
  }
  `;
}