@terafina/tffa-sfdx-plugin 17.0.0-rc.11 → 17.0.0-rc.13

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.
Files changed (51) hide show
  1. package/README.md +9 -9
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +12 -6
  4. package/lib/commands/tffa/apexdoc.d.ts +0 -31
  5. package/lib/commands/tffa/data/export.d.ts +0 -83
  6. package/lib/commands/tffa/data/import.d.ts +0 -79
  7. package/lib/commands/tffa/lint.d.ts +0 -22
  8. package/lib/commands/tffa/meta.d.ts +0 -16
  9. package/lib/commands/tffa/ping.d.ts +0 -10
  10. package/lib/commands/tffa/source/apiset.d.ts +0 -10
  11. package/lib/commands/tffa/source/createfield.d.ts +0 -50
  12. package/lib/index.d.ts +0 -5
  13. package/lib/services/apexdoc/common/apex-docs-error.d.ts +0 -23
  14. package/lib/services/apexdoc/common/array-utils.d.ts +0 -9
  15. package/lib/services/apexdoc/common/line-reader.d.ts +0 -40
  16. package/lib/services/apexdoc/common/models/apex-model.d.ts +0 -51
  17. package/lib/services/apexdoc/common/models/class-group.d.ts +0 -10
  18. package/lib/services/apexdoc/common/models/class-model.d.ts +0 -41
  19. package/lib/services/apexdoc/common/models/engine-config.d.ts +0 -23
  20. package/lib/services/apexdoc/common/models/enum-model.d.ts +0 -15
  21. package/lib/services/apexdoc/common/models/index.d.ts +0 -10
  22. package/lib/services/apexdoc/common/models/method-model.d.ts +0 -26
  23. package/lib/services/apexdoc/common/models/property-model.d.ts +0 -12
  24. package/lib/services/apexdoc/common/models/top-level-model.d.ts +0 -19
  25. package/lib/services/apexdoc/common/settings.d.ts +0 -56
  26. package/lib/services/apexdoc/common/tags.d.ts +0 -22
  27. package/lib/services/apexdoc/common/utils.d.ts +0 -39
  28. package/lib/services/apexdoc/common/validator-engine.d.ts +0 -23
  29. package/lib/services/apexdoc/common/validator.d.ts +0 -16
  30. package/lib/services/apexdoc/engine/file-manager.d.ts +0 -52
  31. package/lib/services/apexdoc/engine/generators/generator-utils.d.ts +0 -12
  32. package/lib/services/apexdoc/engine/generators/menu-generator.d.ts +0 -9
  33. package/lib/services/apexdoc/engine/generators/models/child-enum-markup-generator.d.ts +0 -10
  34. package/lib/services/apexdoc/engine/generators/models/class-markup-generator.d.ts +0 -8
  35. package/lib/services/apexdoc/engine/generators/models/enum-markup-generator.d.ts +0 -9
  36. package/lib/services/apexdoc/engine/generators/models/markup-generator.d.ts +0 -27
  37. package/lib/services/apexdoc/engine/generators/models/method-markup-generator.d.ts +0 -22
  38. package/lib/services/apexdoc/engine/generators/models/property-markup-generator.d.ts +0 -11
  39. package/lib/services/apexdoc/engine/generators/models/source-markup-generator.d.ts +0 -10
  40. package/lib/services/apexdoc/engine/generators/models/top-level-markup-generator.d.ts +0 -10
  41. package/lib/services/apexdoc/engine/generators/see-link-generator.d.ts +0 -20
  42. package/lib/services/lint/apex-class-scan.d.ts +0 -31
  43. package/lib/services/lint/apex-pmd.d.ts +0 -10
  44. package/lib/services/lint/eslint-scan.d.ts +0 -13
  45. package/lib/services/lint/metadata-scan.d.ts +0 -30
  46. package/lib/services/lint/rules.d.ts +0 -10
  47. package/lib/services/lint/stylelint-scan.d.ts +0 -13
  48. package/lib/services/meta/field-scan.d.ts +0 -23
  49. package/lib/utils/constants.d.ts +0 -9
  50. package/lib/utils/ignored-files.d.ts +0 -18
  51. package/lib/utils/jreSetupManager.d.ts +0 -17
package/README.md CHANGED
@@ -41,7 +41,7 @@ $ npm install -g @terafina/tffa-sfdx-plugin
41
41
  $ sfdx COMMAND
42
42
  running command...
43
43
  $ sfdx (--version|-v)
44
- @terafina/tffa-sfdx-plugin/17.0.0-rc.11 linux-x64 node-v18.14.0
44
+ @terafina/tffa-sfdx-plugin/17.0.0-rc.13 darwin-arm64 node-v18.14.0
45
45
  $ sfdx --help [COMMAND]
46
46
  USAGE
47
47
  $ sfdx COMMAND
@@ -109,7 +109,7 @@ EXAMPLES
109
109
  $ sfdx tffa:apexdoc
110
110
  ```
111
111
 
112
- _See code: [src/commands/tffa/apexdoc.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/apexdoc.ts)_
112
+ _See code: [src/commands/tffa/apexdoc.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/apexdoc.ts)_
113
113
 
114
114
  ## `sfdx tffa:data:export`
115
115
 
@@ -161,7 +161,7 @@ EXAMPLES
161
161
  Writing 144 records to ./data/configuration/DisclosureMatrix__c.json
162
162
  ```
163
163
 
164
- _See code: [src/commands/tffa/data/export.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/data/export.ts)_
164
+ _See code: [src/commands/tffa/data/export.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/data/export.ts)_
165
165
 
166
166
  ## `sfdx tffa:data:import`
167
167
 
@@ -236,7 +236,7 @@ EXAMPLES
236
236
  Importing record(s) and relationships of tffa__AddOnService__c... done
237
237
  ```
238
238
 
239
- _See code: [src/commands/tffa/data/import.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/data/import.ts)_
239
+ _See code: [src/commands/tffa/data/import.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/data/import.ts)_
240
240
 
241
241
  ## `sfdx tffa:lint`
242
242
 
@@ -290,7 +290,7 @@ EXAMPLES
290
290
  $sfdx tffa:lint
291
291
  ```
292
292
 
293
- _See code: [src/commands/tffa/lint.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/lint.ts)_
293
+ _See code: [src/commands/tffa/lint.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/lint.ts)_
294
294
 
295
295
  ## `sfdx tffa:meta`
296
296
 
@@ -318,7 +318,7 @@ EXAMPLES
318
318
  $ sfdx tffa:meta
319
319
  ```
320
320
 
321
- _See code: [src/commands/tffa/meta.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/meta.ts)_
321
+ _See code: [src/commands/tffa/meta.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/meta.ts)_
322
322
 
323
323
  ## `sfdx tffa:ping`
324
324
 
@@ -338,7 +338,7 @@ EXAMPLES
338
338
  $ sfdx tffa:ping
339
339
  ```
340
340
 
341
- _See code: [src/commands/tffa/ping.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/ping.ts)_
341
+ _See code: [src/commands/tffa/ping.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/ping.ts)_
342
342
 
343
343
  ## `sfdx tffa:source:apiset`
344
344
 
@@ -362,7 +362,7 @@ EXAMPLES
362
362
  $ sfdx tffa:source:apiset
363
363
  ```
364
364
 
365
- _See code: [src/commands/tffa/source/apiset.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/source/apiset.ts)_
365
+ _See code: [src/commands/tffa/source/apiset.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/source/apiset.ts)_
366
366
 
367
367
  ## `sfdx tffa:source:createfield`
368
368
 
@@ -426,7 +426,7 @@ EXAMPLES
426
426
  Creates a long textarea field
427
427
  ```
428
428
 
429
- _See code: [src/commands/tffa/source/createfield.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.11/src/commands/tffa/source/createfield.ts)_
429
+ _See code: [src/commands/tffa/source/createfield.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v17.0.0-rc.13/src/commands/tffa/source/createfield.ts)_
430
430
 
431
431
  ## `sfdx version`
432
432
 
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "17.0.0-rc.11",
2
+ "version": "17.0.0-rc.13",
3
3
  "commands": {
4
4
  "tffa:apexdoc": {
5
5
  "id": "tffa:apexdoc",
package/package.json CHANGED
@@ -1,10 +1,11 @@
1
1
  {
2
2
  "name": "@terafina/tffa-sfdx-plugin",
3
3
  "description": "sfdx plugin from Terafina containing tools for scanning and extending digital applications for the financial services industry.",
4
- "version": "17.0.0-rc.11",
4
+ "version": "17.0.0-rc.13",
5
5
  "author": "Terafina Inc",
6
6
  "bugs": "https://github.com/terafinainc/tffa-sfdx-plugin/issues",
7
7
  "dependencies": {
8
+ "@oclif/core": "2.1.2",
8
9
  "@salesforce/core": "3.33.1",
9
10
  "@salesforce/sf-plugins-core": "2.1.1",
10
11
  "find-java-home": "2.0.0",
@@ -17,13 +18,13 @@
17
18
  "tslib": "2.5.0",
18
19
  "xml2js": "0.4.23",
19
20
  "recursive-readdir": "2.2.3",
20
- "replace-in-file": "6.3.5"
21
- },
22
- "devDependencies": {
21
+ "replace-in-file": "6.3.5",
23
22
  "@oclif/plugin-help": "5.2.4",
24
23
  "@oclif/plugin-plugins": "2.3.2",
25
24
  "@oclif/plugin-version": "1.2.1",
26
- "@oclif/plugin-warn-if-update-available": "2.0.27",
25
+ "@oclif/plugin-warn-if-update-available": "2.0.27"
26
+ },
27
+ "devDependencies": {
27
28
  "@commitlint/cli": "17.4.2",
28
29
  "@commitlint/config-angular": "17.4.2",
29
30
  "@oclif/test": "2.3.6",
@@ -102,7 +103,12 @@
102
103
  "@oclif/plugin-help",
103
104
  "@oclif/plugin-version",
104
105
  "@oclif/plugin-warn-if-update-available"
105
- ]
106
+ ],
107
+ "warn-if-update-available": {
108
+ "timeoutInDays": 7,
109
+ "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>.",
110
+ "registry": "https://registry.npmjs.org"
111
+ }
106
112
  },
107
113
  "main": "lib/index.js",
108
114
  "repository": "terafina/tffa-sfdx-plugin",
@@ -1,31 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { SfCommand } from '@salesforce/sf-plugins-core';
5
- export default class ApexDoc extends SfCommand<void> {
6
- static description: string;
7
- private logger;
8
- static examples: string[];
9
- private currentFile;
10
- static readonly flags: {
11
- sourcefolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
12
- destfolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
13
- };
14
- run(): Promise<void>;
15
- /**
16
- * Entry point for the program. Called by SFDX on extension activation.
17
- *
18
- * @param config The configuration collected from the users config,
19
- * supplemented with any defaults if user did not include them.
20
- */
21
- private generateDocs;
22
- private createClassGroupMap;
23
- /**
24
- * The main routine for parsing our Apex files. Here we collect ApexDox comments, and create
25
- * models of our top-level types (Classes and Enums) and their members (Enum values, Methods,
26
- * Properties, Inner Classes, etc.).
27
- *
28
- * @param filePath The path of the file being parsed
29
- */
30
- private parseFileContents;
31
- }
@@ -1,83 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { Org } from '@salesforce/core';
5
- import { SfCommand } from '@salesforce/sf-plugins-core';
6
- export default class DataExport extends SfCommand<void> {
7
- static requiresUsername: boolean;
8
- static description: string;
9
- static examples: string[];
10
- static readonly flags: {
11
- sobjecttypes: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
12
- outputdir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
13
- groupby: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
14
- orderby: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
15
- children: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
16
- skipconfigplan: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
17
- 'target-org': import("@oclif/core/lib/interfaces").OptionFlag<Org, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
18
- 'api-version': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
19
- };
20
- /**
21
- * Custom prefixes
22
- */
23
- private sObjectTypePrefixMap;
24
- protected org?: Org;
25
- flagsData: any;
26
- run(): Promise<any>;
27
- private execute;
28
- /**
29
- * Gets fields to be included when exporting records.
30
- */
31
- private getFields;
32
- /**
33
- * Gets the field to be used for ordering when exporting the records.
34
- */
35
- private getOrderBy;
36
- /**
37
- * Transforms the exported records, making it ready for writing to config files
38
- * @param records
39
- */
40
- private transform;
41
- /**
42
- * Gets the external id of the record
43
- * @param record
44
- * @returns
45
- * @throws Error if external id or equivalent is not found
46
- */
47
- private getExternalId;
48
- /**
49
- * Gets the reference id for the record
50
- * @param record
51
- */
52
- private getReferenceId;
53
- /**
54
- * Gets the object prefix to be used when building the reference id
55
- * @param sObjectType
56
- * @returns
57
- */
58
- private getPrefix;
59
- /**
60
- * Writes records to JSON files
61
- * @param records
62
- */
63
- private writeRecords;
64
- /**
65
- * Counts the number of SObjects within the record. e.g. a record containing child relationships may contain more than one SObject.
66
- * @param record
67
- * @returns
68
- */
69
- private getSObjectCount;
70
- /**
71
- * Gets the export plan for the specified object type.
72
- * @param sObjectType
73
- * @returns
74
- */
75
- private getExportPlan;
76
- private getChildExportPlan;
77
- /**
78
- * Returns a map of records where key is record.Id and value is record.
79
- * @param records
80
- * @returns
81
- */
82
- private toMap;
83
- }
@@ -1,79 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { Org } from '@salesforce/core';
5
- import { SfCommand } from '@salesforce/sf-plugins-core';
6
- /**
7
- * Stores external id information of a record.
8
- * Stores both the external id field name and value.
9
- */
10
- declare type ExternalId = {
11
- fieldName: string;
12
- value: string;
13
- };
14
- export default class DataImport extends SfCommand<void> {
15
- static requiresUsername: boolean;
16
- static requiresProject: boolean;
17
- static description: string;
18
- static examples: string[];
19
- static readonly flags: {
20
- sobjectfiles: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
21
- plan: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
22
- sobjecttypes: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
23
- forceimport: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
24
- 'target-org': import("@oclif/core/lib/interfaces").OptionFlag<Org, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
25
- 'api-version': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
26
- };
27
- protected referenceIdExternalIdMap: Map<string, ExternalId>;
28
- private isScratch;
29
- private namespacePrefix;
30
- protected org?: Org;
31
- flagsData: any;
32
- run(): Promise<any>;
33
- /**
34
- * Gathers external ids from the specified records. The external id of each record along with the external id field name
35
- * is stored as a lookup reference mapped to the reference id of the record.
36
- * @see referenceIdExternalIdMap
37
- * @param records
38
- */
39
- private collectExternalIds;
40
- /**
41
- * Upserts the records using sfdx bulk2 API.
42
- * @param records SObject records
43
- */
44
- private upsert;
45
- /**
46
- * Creates an upsert request for the records
47
- * @param records
48
- */
49
- private createUpsertRequest;
50
- /**
51
- * Executes the upsert request. May include execution of child upsert requests if the records have child relationships.
52
- * @param request
53
- */
54
- private execute;
55
- /**
56
- * Logs the success/error metrics
57
- * @param result
58
- * @param request
59
- */
60
- private logResult;
61
- /**
62
- * Checks if file has changed since the last time it was seen by comparing it's last modified date to last known one.
63
- * @param sobjectfile
64
- * @returns
65
- */
66
- private determineIfFileChanged;
67
- /**
68
- * Tracks the files for any changes in future. Uses last modified date to track changes.
69
- * @param sobjectfiles
70
- */
71
- private trackFileChange;
72
- /**
73
- * Returns the external id field names to be used for:
74
- * 1. resolving external ids of lookup references on records
75
- * 2. resolving the external id of records for upsert
76
- */
77
- private getExternalIdFieldNames;
78
- }
79
- export {};
@@ -1,22 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { SfCommand } from '@salesforce/sf-plugins-core';
5
- export default class Lint extends SfCommand<void> {
6
- static description: string;
7
- static examples: string[];
8
- private logger;
9
- static readonly flags: {
10
- sourcefolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
11
- minapi: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
12
- json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
13
- rulesetpath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
14
- eject: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
15
- level: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
16
- };
17
- run(): Promise<any>;
18
- /**
19
- * print output
20
- */
21
- private printViolations;
22
- }
@@ -1,16 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { SfCommand } from '@salesforce/sf-plugins-core';
5
- export default class Meta extends SfCommand<void> {
6
- static description: string;
7
- static examples: string[];
8
- static readonly flags: {
9
- sourcefolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
10
- destpath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
11
- clientname: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
12
- output: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
13
- fields: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
14
- };
15
- run(): Promise<any>;
16
- }
@@ -1,10 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { SfCommand } from '@salesforce/sf-plugins-core';
5
- export default class Ping extends SfCommand<void> {
6
- static description: string;
7
- static examples: string[];
8
- protected static flagsConfig: {};
9
- run(): Promise<any>;
10
- }
@@ -1,10 +0,0 @@
1
- import { SfCommand } from '@salesforce/sf-plugins-core';
2
- export default class SourceApiSet extends SfCommand<void> {
3
- static description: string;
4
- static examples: string[];
5
- static readonly flags: {
6
- sourcefolder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
7
- api: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
8
- };
9
- run(): Promise<any>;
10
- }
@@ -1,50 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { SfCommand } from '@salesforce/sf-plugins-core';
5
- /**
6
- * Copyright (c) NCR Terafina
7
- **/
8
- export default class CreateField extends SfCommand<void> {
9
- static requiresUsername: boolean;
10
- static requiresProject: boolean;
11
- static description: string;
12
- static examples: string[];
13
- static readonly flags: {
14
- sobjecttype: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
15
- name: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
16
- type: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
17
- required: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
18
- length: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
19
- description: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
20
- permissionsets: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
21
- valuesetname: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
22
- };
23
- private projectdir;
24
- run(): Promise<any>;
25
- /**
26
- * Creates a field definition for the field and writes it to the field-meta xml file.
27
- * Additional attributes of the field definition are parsed from the flag parameters.
28
- * @param sObjectType
29
- * @param fieldName
30
- */
31
- private createField;
32
- /**
33
- * Adds a field permission entry for the field to the specified permission sets.
34
- * @param permissionSets
35
- * @param sObjectType
36
- * @param fieldName
37
- */
38
- private addToPermissionSets;
39
- /**
40
- * Reads the xml file and returns an xml object
41
- * @param filename
42
- */
43
- private readXml;
44
- /**
45
- * Writes the xml object into the specified file
46
- * @param filename
47
- * @param xmlObject
48
- */
49
- private writeXml;
50
- }
package/lib/index.d.ts DELETED
@@ -1,5 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- declare const _default: {};
5
- export default _default;
@@ -1,23 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- declare class ApexDoxError extends Error {
5
- static INVALID_SCOPE: string;
6
- static SCOPE_ENTRIES_MAX: string;
7
- static SCOPE_ENTRIES_MIN: string;
8
- static INVALID_DIRECTORY: (arg: string, path: string) => string;
9
- static INVALID_SORT_ORDER: (sortOrder: string) => string;
10
- static INVALID_PORT: (port: number) => string;
11
- static INVALID_SOURCE_URL: (url: string) => string;
12
- static INVALID_TARGET_DIRECTORY: (path: string) => string;
13
- static ONLY_STRINGS: (arg: string) => string;
14
- static SCOPE_ENTRY_INVALID: (entry: string) => string;
15
- static INVALID_TYPE: (arg: string, type: string) => string;
16
- static NO_FILES_FOUND: (sourceDirs: string) => string;
17
- static ASSET_NOT_FOUND: (asset: string) => string;
18
- static INVALID_EXTENSION: (arg: string, path: string, extension: string) => string;
19
- static INVALID_SEE_QUALIFIER: string;
20
- static CONFIG_PARSE_ERROR: (fileName: string) => string;
21
- static UNKNOWN_CONFIG_SETTING: (field: string) => string;
22
- }
23
- export default ApexDoxError;
@@ -1,9 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { IOnlyExcept } from '../index';
5
- export declare const last: <T>(arr: T[]) => T;
6
- export declare const head: <T>(arr: T[]) => T;
7
- export declare const tail: <T>(arr: T[]) => T[];
8
- export declare const except: IOnlyExcept;
9
- export declare const only: IOnlyExcept;
@@ -1,40 +0,0 @@
1
- import { Option } from '../index';
2
- /**
3
- * A utility class similar to C#'s LineReader for synchronously reading a file line by line.
4
- * Uses Node's `readFileSync` to produce an array of lines and implements a simple iterator
5
- * to advance through them. This may be less space efficient than using Node's native line
6
- * reader, however, it keeps things synchronous, and avoids callbacks.
7
- */
8
- declare class LineReader {
9
- private lines;
10
- private nextIndex;
11
- private end;
12
- private content;
13
- constructor(filePath: string);
14
- /**
15
- * Returns the next line and advances the reader a single step.
16
- * @returns The next line, or null if there is no next line.
17
- */
18
- readLine(): Option<string, null>;
19
- /**
20
- * Returns the previous line without affecting the reader's position.
21
- * @returns String, the previous line, or null if there is no previous line.
22
- */
23
- peekPrevLine(): Option<string, null>;
24
- /**
25
- * Returns the next line without advancing the reader.
26
- * @returns String, the next line, or null if there is no next line.
27
- */
28
- peekNextLine(): Option<string, null>;
29
- /**
30
- * Convert the line reader's lines into a single string.
31
- * @param trim A flag for determining whether or not white space
32
- * between lines should be trimmed before concatenating into a
33
- * single string.
34
- * @param separator The character to join the lines by. Defaults to ''.
35
- */
36
- toString(trim?: boolean, separator?: string): string;
37
- toContent(): string;
38
- toArray(): string[];
39
- }
40
- export default LineReader;
@@ -1,51 +0,0 @@
1
- import { Option } from '../..';
2
- declare abstract class ApexModel {
3
- protected _annotations: string[];
4
- protected _author: string;
5
- protected _deprecated: string;
6
- protected _description: string;
7
- protected _example: string;
8
- protected _apipath: string;
9
- protected _restUrl: string;
10
- protected _apimethod: string;
11
- protected _exception: string[];
12
- protected _groupContentPath: string;
13
- protected _groupName: string;
14
- protected _tags: string;
15
- protected _lineNum: number;
16
- protected _nameLine: string;
17
- protected _params: string[];
18
- protected _queryparams: string[];
19
- protected _requestheaders: string[];
20
- protected _responseheaders: string[];
21
- protected _returns: string;
22
- protected _scope: string;
23
- protected _see: string[];
24
- protected _since: string;
25
- protected _sourceUrl?: string;
26
- protected _source: string;
27
- protected constructor(comments: string[], sourceUrl: Option<string>);
28
- abstract get name(): string;
29
- get annotations(): string[];
30
- get description(): string;
31
- get lineNum(): number;
32
- get nameLine(): string;
33
- get scope(): string;
34
- get sourceUrl(): Option<string>;
35
- get source(): string;
36
- setSource(source: string): void;
37
- get example(): string;
38
- get apipath(): string;
39
- get restUrl(): string;
40
- get apimethod(): string;
41
- get deprecated(): string;
42
- get see(): string[];
43
- /**
44
- * This method is based closely on: https://gitlab.com/StevenWCox/sfapexdoc/blob/master/src/apex/com/main/Model.java#L196
45
- */
46
- private parseComments;
47
- parseAnnotations(line: string, previousLine: Option<string, null>): void;
48
- protected parseScope(): void;
49
- protected setNameLine(_nameLine: string, _lineNum: number): void;
50
- }
51
- export { ApexModel };
@@ -1,10 +0,0 @@
1
- declare class ClassGroup {
2
- private _name;
3
- private _contentSource;
4
- constructor(name: string, contentSource: string);
5
- get name(): string;
6
- get contentSource(): string;
7
- set contentSource(contentSource: string);
8
- get contentFileName(): string;
9
- }
10
- export { ClassGroup };
@@ -1,41 +0,0 @@
1
- /**
2
- * Copyright (c) NCR Terafina
3
- **/
4
- import { EnumModel } from './enum-model';
5
- import { MethodModel } from './method-model';
6
- import { TopLevelModel } from './top-level-model';
7
- import { IDTODefinition, IRestPath, IRestTags, Option } from '../..';
8
- import { PropertyModel } from './property-model';
9
- declare class ClassModel extends TopLevelModel {
10
- private _childClassMap;
11
- private _cModelParent?;
12
- private _enums;
13
- private _isInterface;
14
- private _methods;
15
- private _properties;
16
- private _hasGlobalMethods;
17
- constructor(cModelParent: Option<ClassModel>, comments: string[], nameLine: string, lineNum: number, sourceUrl: Option<string>);
18
- addChildClass(child: ClassModel): void;
19
- get childClasses(): Array<ClassModel>;
20
- get childClassesSorted(): Array<ClassModel>;
21
- get childClassMap(): Map<string, ClassModel>;
22
- get enums(): Array<EnumModel>;
23
- get enumsSorted(): Array<EnumModel>;
24
- get groupName(): string;
25
- get tags(): IRestTags;
26
- get isInterface(): boolean;
27
- get isDTO(): boolean;
28
- get methods(): Array<MethodModel>;
29
- get restDefinition(): IRestPath[];
30
- get dtoDefinition(): IDTODefinition;
31
- get methodsSorted(): Array<MethodModel>;
32
- get name(): string;
33
- get properties(): Array<PropertyModel>;
34
- get propertiesSorted(): Array<PropertyModel>;
35
- get topMostClassName(): string;
36
- private setIsInterface;
37
- setHasGlobalMethods(_hasGlobalMethods: boolean): void;
38
- get hasGlobalMethods(): boolean;
39
- get isInnerClass(): boolean;
40
- }
41
- export { ClassModel };
@@ -1,23 +0,0 @@
1
- import { IEngineConfig } from '../..';
2
- declare class EngineConfig implements IEngineConfig {
3
- workspaceFolder: string;
4
- port: number;
5
- source: {
6
- path: string;
7
- sourceUrl: string;
8
- }[];
9
- targetDirectory: string;
10
- includes: string[];
11
- excludes: string[];
12
- homePagePath: string;
13
- scope: string[];
14
- title: string;
15
- subtitle: string;
16
- showTOCSnippets: boolean;
17
- sortOrder: string;
18
- cleanDir: boolean;
19
- assets: any[];
20
- pages: any[];
21
- constructor(workspaceFolder?: string, destfolder?: string);
22
- }
23
- export default EngineConfig;