yini-parser 1.1.0-beta → 1.2.0-beta

package/dist/core/types.d.ts

@@ -1,249 +0,0 @@
-/**
- * @note
- *   The use of null vs undefined
- *   ----------------------------
- *   The convention here (in this file) is:
- *   - undefined is used where a value is missing, or does not apply.
- *   - null is used where a value is missing or has not yet been computed.
- */
-export type TJSObject = any;
-export type TSourceType = 'File' | 'Inline';
-export type TSubjectType = 'None/Ignore' | TSourceType;
-export type TBailSensitivityLevel = 0 | 1 | 2;
-export type TPreferredFailLevel = 'auto' | 0 | 1 | 2;
-export type TPersistThreshold = '0-Ignore-Errors' | '1-Abort-on-Errors' | '2-Abort-Even-on-Warnings';
-/**
- * Only for returned meta data to user.
- * NOTE: Only use lower case snake_case for keys.
- */
-export type TFailLevelKey = 'ignore_errors' | 'abort_on_errors' | 'abort_on_warnings';
-/**
- * Scalar literal, a single, indivisible piece of data:
- * string, number, boolean, and null.
- * @property {string | undefined} [tag]
- *           Its contents may change at any time and should not
- *           be relied upon for any significant purpose.
- * @note Undefined is included here despite that JSON cannot represent
- *       it (undefined), but JS objects can (it's sometimes useful in
- *       debugging etc), it will later get stripped if converted into JSON.
- */
-export type TScalarValue = {
-    type: 'String';
-    value: string;
-    tag: string | undefined;
-} | {
-    type: 'Number';
-    value: number;
-    tag: string | undefined;
-} | {
-    type: 'Boolean';
-    value: boolean;
-    tag: string | undefined;
-} | {
-    type: 'Null';
-    value: null;
-    tag: string | undefined;
-} | {
-    type: 'Undefined';
-    value: undefined;
-    tag: string | undefined;
-};
-/** Any literal value in YINI: scalar, list, or object. */
-export type TValueLiteral = TScalarValue | TListValue | TObjectValue;
-/**
- * @property {string | undefined} [tag]
- *           Debugging only. Its contents may change at any time and
- *           must not be relied upon for any functional purpose.
- */
-export type TListValue = {
-    type: 'List';
-    elems: readonly TValueLiteral[];
-    tag: string | undefined;
-};
-/**
- * @property {string | undefined} [tag]
- *           Debugging only. Its contents may change at any time and
- *           must not be relied upon for any functional purpose.
- */
-export type TObjectValue = {
-    type: 'Object';
-    entries: Readonly<Record<string, TValueLiteral>>;
-    tag: string | undefined;
-};
-export type TSectionHeaderType = undefined | 'Classic-Header-Marker' | 'Numeric-Header-Marker';
-export type TIssueType = 'Fatal-Error' | 'Internal-Error' | 'Syntax-Error' | 'Syntax-Warning' | 'Notice' | 'Info';
-interface IMetaBaseInfo {
-    sourceType: TSourceType;
-    fileName: string | undefined;
-}
-/**
- * Internal runtime info / meta data.
- * @note Used for internal diagnostics, bookkeeping, state, etc.
- */
-export interface IRuntimeInfo extends IMetaBaseInfo {
-    lineCount: number | null;
-    fileByteSize: number | null;
-    timeIoMs: number | null;
-    preferredBailSensitivity: null | TPreferredFailLevel;
-    sha256: string | null;
-}
-export interface IParseCoreOptions {
-    isStrict: boolean;
-    bailSensitivity: TBailSensitivityLevel;
-    isIncludeMeta: boolean;
-    isWithDiagnostics: boolean;
-    isWithTiming: boolean;
-    isKeepUndefinedInMeta: boolean;
-    isRequireDocTerminator: boolean;
-}
-/**
- * User-facing options, these are external and should be more user friendly,
- * and shorter, parameter names than the (more descriptive) internal
- * engine option names.
- *
- * @note These parameters are emphasizes a bit more than the other options,
- *       therefor these are kept a bit shorter for usability-purposes.
- * @note These are the same as in the "simple positional API" function in
- *       the YINI class.
- */
-interface IPrimaryUserParams {
-    strictMode?: boolean;
-    failLevel?: TPreferredFailLevel;
-    includeMetaData?: boolean;
-}
-export interface IAllUserOptions extends IPrimaryUserParams {
-    includeDiagnostics?: boolean;
-    includeTiming?: boolean;
-    preserveUndefinedInMeta?: boolean;
-    requireDocTerminator?: boolean;
-}
-export interface IYiniAST extends IMetaBaseInfo {
-    root: IYiniSection;
-    isStrict: boolean;
-    terminatorSeen: boolean;
-    yiniMarkerSeen: boolean;
-    maxDepth: number | null;
-    numOfSections: number;
-    numOfMembers: number;
-    sectionNamePaths: string[] | null;
-}
-export interface IYiniSection {
-    sectionName: string;
-    level: number;
-    members: Map<string, TValueLiteral>;
-    children: IYiniSection[];
-}
-export interface IBuildOptions {
-    mode?: 'lenient' | 'strict';
-    onDuplicateKey?: 'error' | 'warn' | 'keep-first' | 'overwrite';
-}
-export interface IIssuePayload {
-    line: number | undefined;
-    column: number | undefined;
-    typeKey: string;
-    message: string;
-    advice: string | undefined;
-    hint: string | undefined;
-}
-/**
- * @note NOTE: USE NO TYPES here (or neither in nested structures), they
- *       should only be strings (and content MUST be transformed from the
- *       types to lower snake case)
- *
- *       *** DUE TO make easier for tooling ***
- *
- * @note UPDATE 'metaSchemaVersion' on any edits to the meta structure.
- */
-export interface IResultMetaData {
-    parserVersion: string;
-    mode: 'lenient' | 'strict';
-    orderPreserved: boolean;
-    totalErrors: number;
-    totalWarnings: number;
-    totalMessages: number;
-    runStartedAt: string;
-    runFinishedAt: string;
-    durationMs: number;
-    source: {
-        sourceType: string;
-        fileName: undefined | string;
-        hasDocumentTerminator: boolean;
-        hasYiniMarker: boolean;
-        byteSize: null | number;
-        lineCount: null | number;
-        sha256: null | string;
-    };
-    structure: {
-        maxDepth: null | number;
-        sectionCount: null | number;
-        memberCount: null | number;
-        keysParsedCount: null | number;
-        sectionNamePaths: string[] | null;
-    };
-    metaSchemaVersion: '1.0.0';
-    diagnostics?: {
-        failLevel: {
-            preferredLevel: null | 'auto' | 0 | 1 | 2;
-            levelUsed: TBailSensitivityLevel;
-            levelKey: TFailLevelKey;
-            levelLabel: TPersistThreshold;
-            levelDescription: string | null;
-        };
-        errors: {
-            errorCount: number;
-            payload: IIssuePayload[];
-        };
-        warnings: {
-            warningCount: number;
-            payload: IIssuePayload[];
-        };
-        notices: {
-            noticeCount: number;
-            payload: IIssuePayload[];
-        };
-        infos: {
-            infoCount: number;
-            payload: IIssuePayload[];
-        };
-        environment: {
-            NODE_ENV: undefined | string;
-            APP_ENV: undefined | string;
-            lib: {
-                nodeEnv: undefined | string;
-                appEnv: undefined | string;
-                flags: {
-                    isDev: boolean;
-                    isDebug: boolean;
-                };
-            };
-        };
-        optionsUsed: IAllUserOptions;
-    };
-    timing?: {
-        total: null | {
-            timeMs: number;
-            name: string;
-        };
-        phase0: undefined | {
-            timeMs: number;
-            name: string;
-        };
-        phase1: null | {
-            timeMs: number;
-            name: string;
-        };
-        phase2: null | {
-            timeMs: number;
-            name: string;
-        };
-        phase3: null | {
-            timeMs: number;
-            name: string;
-        };
-        phase4: null | {
-            timeMs: number;
-            name: string;
-        };
-    };
-}
-export {};

package/dist/parseEntry.d.ts

@@ -1,3 +0,0 @@
-import { IParseCoreOptions, IRuntimeInfo } from './core/types';
-/** Single source of truth. */
-export declare const _parseMain: (yiniContent: string, options: IParseCoreOptions | undefined, runtimeInfo: IRuntimeInfo) => any;