@patrickdk77/script-defuse 0.0.0-stage → 0.1.0

package/dist/api.d.ts

@@ -0,0 +1,82 @@
+import { ScriptCategory as C, ScriptDetail as D } from './types';
+/**
+ * What a value is, as far as the rules need to know. Host kinds are the viewer's objects; the rest are plain data,
+ * which can reach nothing outside the script.
+ */
+export type Kind = 'doc' | 'field' | 'fields' | 'event' | 'app' | 'util' | 'color' | 'console' | 'constant' | 'math' | 'builtin' | 'xmldata' | 'xfa' | 'xfahost' | 'xfalayout' | 'xfaevent' | 'node' | 'number' | 'string' | 'data' | 'unknown';
+export declare const HOST_KINDS: ReadonlySet<Kind>;
+/** A member of a host object: allowed, giving a value of `kind`, or a finding. */
+export type Member = {
+    kind: Kind;
+    write?: boolean;
+} | {
+    finding: [C, D];
+};
+/** The document: `this`, and what an unqualified name falls back to in a viewer. */
+export declare const DOC: ReadonlyMap<string, Member>;
+/**
+ * Every member Acrobat's Doc object has, form or not. A script that sets one of these on the document, or assigns to
+ * it as a bare name, sets the document's own property; any other name it sets is a global of its own.
+ */
+export declare const DOC_ALL: ReadonlySet<string>;
+/**
+ * A form field, from getField, event.target or event.source: Acrobat's whole Field object. Since every member it has
+ * is here, any other name on a field is one the form set itself, such as event.target.oldVal.
+ */
+export declare const FIELD: ReadonlyMap<string, Member>;
+/** `event`, the object a field or document script runs for. */
+export declare const EVENT: ReadonlyMap<string, Member>;
+/** `app`, the viewer. Message boxes and version checks only. */
+export declare const APP: ReadonlyMap<string, Member>;
+/** `util`: formatting and parsing text, numbers and dates. */
+export declare const UTIL: ReadonlyMap<string, Member>;
+export declare const COLOR: ReadonlyMap<string, Member>;
+export declare const CONSOLE: ReadonlyMap<string, Member>;
+/** `XMLData`, which parses XML text a form holds and queries it. Its parse is checked for entities on its own. */
+export declare const XMLDATA: ReadonlyMap<string, Member>;
+/** Namespaces of constants a form script reads, such as display.hidden. Any member of them is a constant. */
+export declare const CONSTANT_ROOTS: ReadonlySet<string>;
+/** Acrobat's AForm helpers, which format, check and calculate fields. */
+export declare const AFORM: ReadonlySet<string>;
+/** Global functions and namespaces of the language itself that compute on data. */
+export declare const BUILTIN_FUNCTIONS: ReadonlyMap<string, Kind>;
+/** Namespaces whose members are pure computation, apart from the ones named in BUILTIN_DENY. */
+export declare const BUILTIN_NAMESPACES: ReadonlySet<string>;
+/** Members of those namespaces that hide text or reach the machinery behind objects. */
+export declare const BUILTIN_DENY: ReadonlyMap<string, Member>;
+/** Global names that are themselves a finding, wherever they appear. */
+export declare const DENIED_GLOBALS: ReadonlyMap<string, Member>;
+/** Member names that reach the language machinery on any value. */
+export declare const MACHINERY: ReadonlySet<string>;
+/**
+ * Member names a viewer object has that are not form computation. A plain value, such as a function's parameter,
+ * might hold a viewer object, so one of these names on it gets the finding the object would have.
+ */
+export declare const HOST_DENY: ReadonlyMap<string, Member>;
+/**
+ * `xfa`, the root of an XFA form's object model. Its models are trees of form nodes, apart from the host, the
+ * layout and the event, and the connections, sources and signatures that reach outside the form.
+ */
+export declare const XFA_ROOT: ReadonlyMap<string, Member>;
+/** `xfa.host`, the viewer as an XFA form sees it. Message boxes, focus, pages and version checks. */
+export declare const XFA_HOST: ReadonlyMap<string, Member>;
+/** `xfa.layout`: where nodes fall on pages. */
+export declare const XFA_LAYOUT: ReadonlyMap<string, Member>;
+/**
+ * `event` in an XFA script, and `xfa.event`: the XFA event's members and those of Acrobat's event object. Its target
+ * is the Acrobat document.
+ */
+export declare const XFA_EVENT: ReadonlyMap<string, Member>;
+/** Members of a form node that hold its value, rather than another node. Any other member is a node. */
+export declare const NODE_VALUES: ReadonlyMap<string, Kind>;
+/**
+ * Members of form nodes, and of XFA's host and connections reached through a node, that leave the form or run what
+ * the form did not carry. A node can be any object of the model, so any of these names on one is a finding.
+ */
+export declare const NODE_DENY: ReadonlyMap<string, Member>;
+/** Node types a script may not create: they would carry script, actions or content from outside the form. */
+export declare const CODE_NODES: ReadonlySet<string>;
+/** Attributes of a node that name something outside the form. */
+export declare const URL_ATTRIBUTES: ReadonlySet<string>;
+/** Roots of the SOM in an XFA script, written with `$`. `!` is the datasets model. */
+export declare const SOM_ROOTS: ReadonlyMap<string, Kind | Member>;