@meridianjs/types 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -38,6 +38,8 @@ interface ProjectConfig {
38
38
  origin: string | string[];
39
39
  credentials?: boolean;
40
40
  };
41
+ /** Max levels of child issue nesting. Default: 1 (children allowed, grandchildren not). */
42
+ maxChildIssueDepth?: number;
41
43
  }
42
44
  interface MeridianConfig {
43
45
  projectConfig: ProjectConfig;
@@ -164,6 +166,20 @@ interface IQuery {
164
166
  data: T[];
165
167
  }>;
166
168
  }
169
+ interface IStorageProvider {
170
+ /** Upload a file buffer to the given sub-directory. Returns the public URL and storage key. */
171
+ upload(file: {
172
+ buffer: Buffer;
173
+ originalname: string;
174
+ mimetype: string;
175
+ size: number;
176
+ }, subDir: string): Promise<{
177
+ url: string;
178
+ key: string;
179
+ }>;
180
+ /** Delete a file by its public URL or storage key. */
181
+ delete(urlOrKey: string): Promise<void>;
182
+ }
167
183
  interface PluginRegistrationContext {
168
184
  container: MeridianContainer;
169
185
  pluginOptions: Record<string, unknown>;
@@ -171,4 +187,4 @@ interface PluginRegistrationContext {
171
187
  }
172
188
  type PluginRegisterFn = (ctx: PluginRegistrationContext) => Promise<void>;
173
189
 
174
- export type { AdminConfig, AuthenticatedUser, EventMessage, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };
190
+ export type { AdminConfig, AuthenticatedUser, EventMessage, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IStorageProvider, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };
package/dist/index.d.ts CHANGED
@@ -38,6 +38,8 @@ interface ProjectConfig {
38
38
  origin: string | string[];
39
39
  credentials?: boolean;
40
40
  };
41
+ /** Max levels of child issue nesting. Default: 1 (children allowed, grandchildren not). */
42
+ maxChildIssueDepth?: number;
41
43
  }
42
44
  interface MeridianConfig {
43
45
  projectConfig: ProjectConfig;
@@ -164,6 +166,20 @@ interface IQuery {
164
166
  data: T[];
165
167
  }>;
166
168
  }
169
+ interface IStorageProvider {
170
+ /** Upload a file buffer to the given sub-directory. Returns the public URL and storage key. */
171
+ upload(file: {
172
+ buffer: Buffer;
173
+ originalname: string;
174
+ mimetype: string;
175
+ size: number;
176
+ }, subDir: string): Promise<{
177
+ url: string;
178
+ key: string;
179
+ }>;
180
+ /** Delete a file by its public URL or storage key. */
181
+ delete(urlOrKey: string): Promise<void>;
182
+ }
167
183
  interface PluginRegistrationContext {
168
184
  container: MeridianContainer;
169
185
  pluginOptions: Record<string, unknown>;
@@ -171,4 +187,4 @@ interface PluginRegistrationContext {
171
187
  }
172
188
  type PluginRegisterFn = (ctx: PluginRegistrationContext) => Promise<void>;
173
189
 
174
- export type { AdminConfig, AuthenticatedUser, EventMessage, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };
190
+ export type { AdminConfig, AuthenticatedUser, EventMessage, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IStorageProvider, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meridianjs/types",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "Shared TypeScript types and interfaces for Meridian",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",