@valiantys/atlassian-app 3.2.0-alpha-7 → 3.2.0-alpha-9

package/util-adf/atlassian-app.api.md

@@ -0,0 +1,73 @@
+## API Report File for "@valiantys/atlassian-app"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export interface AdfDoc {
+    // (undocumented)
+    content: AdfNode[];
+    // (undocumented)
+    type: 'doc';
+    // (undocumented)
+    version: 1;
+}
+
+// @public
+export interface AdfMark {
+    // (undocumented)
+    attrs?: Record<string, unknown>;
+    // (undocumented)
+    type: string;
+}
+
+// @public
+export interface AdfNode {
+    // (undocumented)
+    attrs?: AdfNodeAttrs;
+    // (undocumented)
+    content?: AdfNode[];
+    // (undocumented)
+    marks?: AdfMark[];
+    // (undocumented)
+    text?: string;
+    // (undocumented)
+    type: string;
+}
+
+// @public
+export interface AdfNodeAttrs {
+    // (undocumented)
+    [key: string]: unknown;
+    // (undocumented)
+    localId?: string;
+    // (undocumented)
+    text?: string;
+}
+
+// @public
+export interface AdfTextNode extends AdfNode {
+    // (undocumented)
+    attrs?: never;
+    // (undocumented)
+    text: string;
+    // (undocumented)
+    type: 'text';
+}
+
+// @public (undocumented)
+export function appendParagraph(doc: AdfDoc, value: string): AdfDoc;
+
+// @public (undocumented)
+export function replaceInAdf(doc: AdfDoc, searchText: string, replacement: string): AdfDoc;
+
+// @public (undocumented)
+export function searchAdf(doc: AdfDoc, searchText: string): boolean;
+
+// @public (undocumented)
+export function toAdfDoc(value: string): AdfDoc;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/util-adf/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/util-adf/src/lib/adf/index.cjs.js");exports.appendParagraph=e.appendParagraph;exports.replaceInAdf=e.replaceInAdf;exports.searchAdf=e.searchAdf;exports.toAdfDoc=e.toAdfDoc;

package/util-adf/index.d.ts

@@ -0,0 +1,57 @@
+/** Root document node */
+export declare interface AdfDoc {
+    type: 'doc';
+    version: 1;
+    content: AdfNode[];
+}
+
+/**
+ * TypeScript types for Atlassian Document Format (ADF)
+ * Conforms to https://unpkg.com/@atlaskit/adf-schema@52.4.0/dist/json-schema/v1/full.json
+ */
+export declare interface AdfMark {
+    type: string;
+    attrs?: Record<string, unknown>;
+}
+
+/**
+ * Base for all ADF nodes. `content` is optional because many block nodes
+ * (paragraph, heading, codeBlock, etc.) define it as optional in the schema.
+ * `text` is only populated on text nodes. `attrs` is present on most non-text
+ * nodes. `marks` is present on nodes that support formatting.
+ */
+export declare interface AdfNode {
+    type: string;
+    text?: string;
+    attrs?: AdfNodeAttrs;
+    content?: AdfNode[];
+    marks?: AdfMark[];
+}
+
+/**
+ * Attrs common across node types. Many inline node types (emoji, mention,
+ * status, placeholder, hardBreak, inlineExtension, extension, bodiedExtension)
+ * store their display text in `attrs.text`.
+ */
+export declare interface AdfNodeAttrs {
+    text?: string;
+    localId?: string;
+    [key: string]: unknown;
+}
+
+/** text node — text is a required top-level property, not in attrs */
+export declare interface AdfTextNode extends AdfNode {
+    type: 'text';
+    text: string;
+    attrs?: never;
+}
+
+export declare function appendParagraph(doc: AdfDoc, value: string): AdfDoc;
+
+export declare function replaceInAdf(doc: AdfDoc, searchText: string, replacement: string): AdfDoc;
+
+export declare function searchAdf(doc: AdfDoc, searchText: string): boolean;
+
+export declare function toAdfDoc(value: string): AdfDoc;
+
+export { }

package/util-adf/index.es.js

@@ -0,0 +1,7 @@
+import { appendParagraph as e, replaceInAdf as p, searchAdf as d, toAdfDoc as f } from "../atlassian/shared/util-adf/src/lib/adf/index.es.js";
+export {
+  e as appendParagraph,
+  p as replaceInAdf,
+  d as searchAdf,
+  f as toAdfDoc
+};

package/util-adf/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.8"
+    }
+  ]
+}