@intersystems-community/ascot 0.0.0-stage → 0.1.0

package/generated/interfaces/iris-ascot-common.d.ts

@@ -0,0 +1,210 @@
+/** @module Interface iris:ascot/common **/
+export interface Position {
+  line: number,
+  character: number,
+}
+export interface NameInfo {
+  before: Position,
+  content: string,
+  after: Position,
+}
+export interface ParameterInfo {
+  t?: string,
+  v?: string,
+}
+/**
+ * # Variants
+ * 
+ * ## `"list"`
+ * 
+ * ## `"array"`
+ */
+export type CollectionKind = 'list' | 'array';
+export interface PropertyInfo {
+  t?: string,
+  collection?: CollectionKind,
+  multidimensional: boolean,
+}
+/**
+ * # Variants
+ * 
+ * ## `"default"`
+ * 
+ * ## `"output"`
+ * 
+ * ## `"by-ref"`
+ */
+export type ArgMode = 'default' | 'output' | 'by-ref';
+export interface Range {
+  start: Position,
+  end: Position,
+}
+export interface NormalArg {
+  mode: ArgMode,
+  name: string,
+  t?: string,
+  'default'?: string,
+  declaredAt?: Range,
+}
+export interface VariadicArg {
+  mode: ArgMode,
+  name: string,
+  t?: string,
+  declaredAt?: Range,
+}
+export interface MethodInfo {
+  normal: Array<NormalArg>,
+  variadic?: VariadicArg,
+  t?: string,
+  procedureBlock?: Array<string>,
+  body: Range,
+}
+export type MemberKind = MemberKindParameter | MemberKindProperty | MemberKindRelationship | MemberKindForeignKey | MemberKindIndex | MemberKindProjection | MemberKindTrigger | MemberKindXData | MemberKindStorage | MemberKindQuery | MemberKindMethod | MemberKindClassMethod | MemberKindClientMethod;
+export interface MemberKindParameter {
+  tag: 'parameter',
+  val: ParameterInfo,
+}
+export interface MemberKindProperty {
+  tag: 'property',
+  val: PropertyInfo,
+}
+export interface MemberKindRelationship {
+  tag: 'relationship',
+  val: string | undefined,
+}
+export interface MemberKindForeignKey {
+  tag: 'foreign-key',
+}
+export interface MemberKindIndex {
+  tag: 'index',
+}
+export interface MemberKindProjection {
+  tag: 'projection',
+}
+export interface MemberKindTrigger {
+  tag: 'trigger',
+}
+export interface MemberKindXData {
+  tag: 'x-data',
+}
+export interface MemberKindStorage {
+  tag: 'storage',
+}
+export interface MemberKindQuery {
+  tag: 'query',
+}
+export interface MemberKindMethod {
+  tag: 'method',
+  val: MethodInfo,
+}
+export interface MemberKindClassMethod {
+  tag: 'class-method',
+  val: MethodInfo,
+}
+export interface MemberKindClientMethod {
+  tag: 'client-method',
+  val: MethodInfo,
+}
+export interface MemberInfo {
+  doc: string,
+  before: Position,
+  name: NameInfo,
+  aliases: Array<string>,
+  deprecated: boolean,
+  kind: MemberKind,
+  after: Position,
+  uri?: string,
+  origin?: string,
+}
+export interface ClassInfo {
+  doc: string,
+  name: NameInfo,
+  'extends': Array<string>,
+  deprecated: boolean,
+  members: Array<MemberInfo>,
+  propertyClassNames: Array<string>,
+  includes: Array<string>,
+  isDatatype?: boolean,
+  uri?: string,
+}
+export interface RoutineSource {
+  text: string,
+  uri?: string,
+}
+export interface Location {
+  uri: string,
+  range: Range,
+}
+export interface DiagnosticRelatedInformation {
+  location: Location,
+  message: string,
+}
+/**
+ * # Variants
+ * 
+ * ## `"error"`
+ * 
+ * ## `"warning"`
+ * 
+ * ## `"information"`
+ * 
+ * ## `"hint"`
+ */
+export type DiagnosticSeverity = 'error' | 'warning' | 'information' | 'hint';
+export interface Diagnostic {
+  message: string,
+  range: Range,
+  relatedInformation: Array<DiagnosticRelatedInformation>,
+  severity: DiagnosticSeverity,
+}
+export interface InlayHint {
+  position: Position,
+  label: string,
+  paddingLeft: boolean,
+  paddingRight: boolean,
+}
+/**
+ * # Variants
+ * 
+ * ## `"class"`
+ * 
+ * ## `"module"`
+ * 
+ * ## `"method"`
+ * 
+ * ## `"property"`
+ * 
+ * ## `"interface"`
+ * 
+ * ## `"function"`
+ * 
+ * ## `"constant"`
+ * 
+ * ## `"array"`
+ * 
+ * ## `"object"`
+ * 
+ * ## `"key"`
+ * 
+ * ## `"struct"`
+ * 
+ * ## `"event"`
+ */
+export type SymbolKind = 'class' | 'module' | 'method' | 'property' | 'interface' | 'function' | 'constant' | 'array' | 'object' | 'key' | 'struct' | 'event';
+export interface SymbolInfo {
+  name: string,
+  kind: SymbolKind,
+  deprecated: boolean,
+  range: Range,
+  selectionRange: Range,
+}
+export interface DocumentSymbol {
+  root: SymbolInfo,
+  members: Array<SymbolInfo>,
+}
+export interface WorkspaceSymbol {
+  name: string,
+  kind: SymbolKind,
+  deprecated: boolean,
+  location: Location,
+}

package/generated/interfaces/iris-ascot-exported.d.ts

@@ -0,0 +1,26 @@
+/** @module Interface iris:ascot/exported **/
+export type MemberInfo = import('./iris-ascot-common.js').MemberInfo;
+export type ClassInfo = import('./iris-ascot-common.js').ClassInfo;
+export type Position = import('./iris-ascot-common.js').Position;
+export type Diagnostic = import('./iris-ascot-common.js').Diagnostic;
+export type InlayHint = import('./iris-ascot-common.js').InlayHint;
+export type Range = import('./iris-ascot-common.js').Range;
+export type Location = import('./iris-ascot-common.js').Location;
+export type DocumentSymbol = import('./iris-ascot-common.js').DocumentSymbol;
+export type WorkspaceSymbol = import('./iris-ascot-common.js').WorkspaceSymbol;
+export type IrisConnection = import('./iris-ascot-imported.js').IrisConnection;
+
+export class Workspace {
+  constructor(env: IrisConnection | undefined)
+  open(uri: string, text: string): Array<string>;
+  close(uri: string): Array<string>;
+  diagnostics(uri: string): Promise<Array<Diagnostic>>;
+  inlayHint(uri: string, range: Range): Promise<Array<InlayHint>>;
+  definition(uri: string, position: Position): Promise<Location | undefined>;
+  references(uri: string, position: Position, includeDeclaration: boolean): Promise<Array<Location>>;
+  hover(uri: string, position: Position): Promise<string | undefined>;
+  queryCls(query: string): Promise<Array<[string, ClassInfo]>>;
+  queryMem(cls: string, query: string): Promise<Array<[string, MemberInfo]>>;
+  documentSymbol(uri: string): Promise<DocumentSymbol | undefined>;
+  workspaceSymbol(query: string): Promise<Array<WorkspaceSymbol>>;
+}

package/generated/interfaces/iris-ascot-imported.d.ts

@@ -0,0 +1,13 @@
+/** @module Interface iris:ascot/imported **/
+export type ClassInfo = import('./iris-ascot-common.js').ClassInfo;
+export type RoutineSource = import('./iris-ascot-common.js').RoutineSource;
+
+export class IrisConnection {
+  /**
+   * This type does not have a public constructor.
+   */
+  private constructor();
+  getCls(cls: string): Promise<ClassInfo | undefined>;
+  getInc(name: string): Promise<RoutineSource | undefined>;
+  getIntOrMac(name: string): Promise<RoutineSource | undefined>;
+}

package/package.json

@@ -1,6 +1,29 @@
 {
   "name": "@intersystems-community/ascot",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "ascot, a type checker and code intelligence engine for InterSystems ObjectScript, for Node and other JS consumers.",
+  "license": "MIT OR Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/intersystems-community/ascot.git",
+    "directory": "bindings/js"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "generated",
+    "lib/*.core*.wasm"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "bash scripts/build.sh"
+  },
+  "devDependencies": {
+    "@bytecodealliance/jco": "^1.37.0",
+    "@types/node": "^26.6.5",
+    "typescript": "^7.0.2"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.