@elevasis/sdk 1.0.2 → 1.2.0
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/cli.cjs +704 -3568
- package/dist/index.d.ts +316 -135
- package/package.json +1 -7
- package/reference/_navigation.md +1 -1
- package/reference/cli.mdx +2 -113
- package/reference/deployment/index.mdx +1 -1
- package/reference/framework/index.mdx +10 -0
- package/reference/framework/project-structure.mdx +2 -3
- package/reference/framework/tutorial-system.mdx +2 -2
- package/reference/getting-started.mdx +1 -11
- package/reference/index.mdx +16 -1
- package/reference/platform-tools/index.mdx +3 -3
- package/reference/platform-tools/type-safety.mdx +2 -2
- package/reference/templates/index.mdx +3 -3
- package/reference/troubleshooting.mdx +4 -4
- package/dist/templates.js +0 -2253
- package/dist/types/templates.d.ts +0 -2
package/dist/index.d.ts
CHANGED
|
@@ -2806,6 +2806,315 @@ type Database = {
|
|
|
2806
2806
|
};
|
|
2807
2807
|
Relationships: [];
|
|
2808
2808
|
};
|
|
2809
|
+
prj_milestones: {
|
|
2810
|
+
Row: {
|
|
2811
|
+
checklist: Json | null;
|
|
2812
|
+
completed_at: string | null;
|
|
2813
|
+
created_at: string;
|
|
2814
|
+
description: string | null;
|
|
2815
|
+
due_date: string | null;
|
|
2816
|
+
id: string;
|
|
2817
|
+
metadata: Json | null;
|
|
2818
|
+
name: string;
|
|
2819
|
+
organization_id: string;
|
|
2820
|
+
project_id: string;
|
|
2821
|
+
sequence: number;
|
|
2822
|
+
status: string;
|
|
2823
|
+
updated_at: string;
|
|
2824
|
+
};
|
|
2825
|
+
Insert: {
|
|
2826
|
+
checklist?: Json | null;
|
|
2827
|
+
completed_at?: string | null;
|
|
2828
|
+
created_at?: string;
|
|
2829
|
+
description?: string | null;
|
|
2830
|
+
due_date?: string | null;
|
|
2831
|
+
id?: string;
|
|
2832
|
+
metadata?: Json | null;
|
|
2833
|
+
name: string;
|
|
2834
|
+
organization_id: string;
|
|
2835
|
+
project_id: string;
|
|
2836
|
+
sequence?: number;
|
|
2837
|
+
status?: string;
|
|
2838
|
+
updated_at?: string;
|
|
2839
|
+
};
|
|
2840
|
+
Update: {
|
|
2841
|
+
checklist?: Json | null;
|
|
2842
|
+
completed_at?: string | null;
|
|
2843
|
+
created_at?: string;
|
|
2844
|
+
description?: string | null;
|
|
2845
|
+
due_date?: string | null;
|
|
2846
|
+
id?: string;
|
|
2847
|
+
metadata?: Json | null;
|
|
2848
|
+
name?: string;
|
|
2849
|
+
organization_id?: string;
|
|
2850
|
+
project_id?: string;
|
|
2851
|
+
sequence?: number;
|
|
2852
|
+
status?: string;
|
|
2853
|
+
updated_at?: string;
|
|
2854
|
+
};
|
|
2855
|
+
Relationships: [
|
|
2856
|
+
{
|
|
2857
|
+
foreignKeyName: "prj_milestones_organization_id_fkey";
|
|
2858
|
+
columns: ["organization_id"];
|
|
2859
|
+
isOneToOne: false;
|
|
2860
|
+
referencedRelation: "organizations";
|
|
2861
|
+
referencedColumns: ["id"];
|
|
2862
|
+
},
|
|
2863
|
+
{
|
|
2864
|
+
foreignKeyName: "prj_milestones_project_id_fkey";
|
|
2865
|
+
columns: ["project_id"];
|
|
2866
|
+
isOneToOne: false;
|
|
2867
|
+
referencedRelation: "prj_projects";
|
|
2868
|
+
referencedColumns: ["id"];
|
|
2869
|
+
}
|
|
2870
|
+
];
|
|
2871
|
+
};
|
|
2872
|
+
prj_notes: {
|
|
2873
|
+
Row: {
|
|
2874
|
+
content: string;
|
|
2875
|
+
created_at: string;
|
|
2876
|
+
created_by: string | null;
|
|
2877
|
+
id: string;
|
|
2878
|
+
metadata: Json | null;
|
|
2879
|
+
milestone_id: string | null;
|
|
2880
|
+
occurred_at: string;
|
|
2881
|
+
organization_id: string;
|
|
2882
|
+
project_id: string;
|
|
2883
|
+
summary: string | null;
|
|
2884
|
+
task_id: string | null;
|
|
2885
|
+
type: string;
|
|
2886
|
+
};
|
|
2887
|
+
Insert: {
|
|
2888
|
+
content: string;
|
|
2889
|
+
created_at?: string;
|
|
2890
|
+
created_by?: string | null;
|
|
2891
|
+
id?: string;
|
|
2892
|
+
metadata?: Json | null;
|
|
2893
|
+
milestone_id?: string | null;
|
|
2894
|
+
occurred_at?: string;
|
|
2895
|
+
organization_id: string;
|
|
2896
|
+
project_id: string;
|
|
2897
|
+
summary?: string | null;
|
|
2898
|
+
task_id?: string | null;
|
|
2899
|
+
type?: string;
|
|
2900
|
+
};
|
|
2901
|
+
Update: {
|
|
2902
|
+
content?: string;
|
|
2903
|
+
created_at?: string;
|
|
2904
|
+
created_by?: string | null;
|
|
2905
|
+
id?: string;
|
|
2906
|
+
metadata?: Json | null;
|
|
2907
|
+
milestone_id?: string | null;
|
|
2908
|
+
occurred_at?: string;
|
|
2909
|
+
organization_id?: string;
|
|
2910
|
+
project_id?: string;
|
|
2911
|
+
summary?: string | null;
|
|
2912
|
+
task_id?: string | null;
|
|
2913
|
+
type?: string;
|
|
2914
|
+
};
|
|
2915
|
+
Relationships: [
|
|
2916
|
+
{
|
|
2917
|
+
foreignKeyName: "prj_notes_created_by_fkey";
|
|
2918
|
+
columns: ["created_by"];
|
|
2919
|
+
isOneToOne: false;
|
|
2920
|
+
referencedRelation: "users";
|
|
2921
|
+
referencedColumns: ["id"];
|
|
2922
|
+
},
|
|
2923
|
+
{
|
|
2924
|
+
foreignKeyName: "prj_notes_milestone_id_fkey";
|
|
2925
|
+
columns: ["milestone_id"];
|
|
2926
|
+
isOneToOne: false;
|
|
2927
|
+
referencedRelation: "prj_milestones";
|
|
2928
|
+
referencedColumns: ["id"];
|
|
2929
|
+
},
|
|
2930
|
+
{
|
|
2931
|
+
foreignKeyName: "prj_notes_organization_id_fkey";
|
|
2932
|
+
columns: ["organization_id"];
|
|
2933
|
+
isOneToOne: false;
|
|
2934
|
+
referencedRelation: "organizations";
|
|
2935
|
+
referencedColumns: ["id"];
|
|
2936
|
+
},
|
|
2937
|
+
{
|
|
2938
|
+
foreignKeyName: "prj_notes_project_id_fkey";
|
|
2939
|
+
columns: ["project_id"];
|
|
2940
|
+
isOneToOne: false;
|
|
2941
|
+
referencedRelation: "prj_projects";
|
|
2942
|
+
referencedColumns: ["id"];
|
|
2943
|
+
},
|
|
2944
|
+
{
|
|
2945
|
+
foreignKeyName: "prj_notes_task_id_fkey";
|
|
2946
|
+
columns: ["task_id"];
|
|
2947
|
+
isOneToOne: false;
|
|
2948
|
+
referencedRelation: "prj_tasks";
|
|
2949
|
+
referencedColumns: ["id"];
|
|
2950
|
+
}
|
|
2951
|
+
];
|
|
2952
|
+
};
|
|
2953
|
+
prj_projects: {
|
|
2954
|
+
Row: {
|
|
2955
|
+
actual_end_date: string | null;
|
|
2956
|
+
client_company_id: string | null;
|
|
2957
|
+
contract_value: number | null;
|
|
2958
|
+
created_at: string;
|
|
2959
|
+
deal_id: string | null;
|
|
2960
|
+
description: string | null;
|
|
2961
|
+
id: string;
|
|
2962
|
+
kind: string;
|
|
2963
|
+
metadata: Json | null;
|
|
2964
|
+
name: string;
|
|
2965
|
+
organization_id: string;
|
|
2966
|
+
start_date: string | null;
|
|
2967
|
+
status: string;
|
|
2968
|
+
target_end_date: string | null;
|
|
2969
|
+
updated_at: string;
|
|
2970
|
+
};
|
|
2971
|
+
Insert: {
|
|
2972
|
+
actual_end_date?: string | null;
|
|
2973
|
+
client_company_id?: string | null;
|
|
2974
|
+
contract_value?: number | null;
|
|
2975
|
+
created_at?: string;
|
|
2976
|
+
deal_id?: string | null;
|
|
2977
|
+
description?: string | null;
|
|
2978
|
+
id?: string;
|
|
2979
|
+
kind?: string;
|
|
2980
|
+
metadata?: Json | null;
|
|
2981
|
+
name: string;
|
|
2982
|
+
organization_id: string;
|
|
2983
|
+
start_date?: string | null;
|
|
2984
|
+
status?: string;
|
|
2985
|
+
target_end_date?: string | null;
|
|
2986
|
+
updated_at?: string;
|
|
2987
|
+
};
|
|
2988
|
+
Update: {
|
|
2989
|
+
actual_end_date?: string | null;
|
|
2990
|
+
client_company_id?: string | null;
|
|
2991
|
+
contract_value?: number | null;
|
|
2992
|
+
created_at?: string;
|
|
2993
|
+
deal_id?: string | null;
|
|
2994
|
+
description?: string | null;
|
|
2995
|
+
id?: string;
|
|
2996
|
+
kind?: string;
|
|
2997
|
+
metadata?: Json | null;
|
|
2998
|
+
name?: string;
|
|
2999
|
+
organization_id?: string;
|
|
3000
|
+
start_date?: string | null;
|
|
3001
|
+
status?: string;
|
|
3002
|
+
target_end_date?: string | null;
|
|
3003
|
+
updated_at?: string;
|
|
3004
|
+
};
|
|
3005
|
+
Relationships: [
|
|
3006
|
+
{
|
|
3007
|
+
foreignKeyName: "prj_projects_client_company_id_fkey";
|
|
3008
|
+
columns: ["client_company_id"];
|
|
3009
|
+
isOneToOne: false;
|
|
3010
|
+
referencedRelation: "acq_companies";
|
|
3011
|
+
referencedColumns: ["id"];
|
|
3012
|
+
},
|
|
3013
|
+
{
|
|
3014
|
+
foreignKeyName: "prj_projects_deal_id_fkey";
|
|
3015
|
+
columns: ["deal_id"];
|
|
3016
|
+
isOneToOne: false;
|
|
3017
|
+
referencedRelation: "acq_deals";
|
|
3018
|
+
referencedColumns: ["id"];
|
|
3019
|
+
},
|
|
3020
|
+
{
|
|
3021
|
+
foreignKeyName: "prj_projects_organization_id_fkey";
|
|
3022
|
+
columns: ["organization_id"];
|
|
3023
|
+
isOneToOne: false;
|
|
3024
|
+
referencedRelation: "organizations";
|
|
3025
|
+
referencedColumns: ["id"];
|
|
3026
|
+
}
|
|
3027
|
+
];
|
|
3028
|
+
};
|
|
3029
|
+
prj_tasks: {
|
|
3030
|
+
Row: {
|
|
3031
|
+
checklist: Json;
|
|
3032
|
+
completed_at: string | null;
|
|
3033
|
+
created_at: string;
|
|
3034
|
+
description: string | null;
|
|
3035
|
+
due_date: string | null;
|
|
3036
|
+
file_url: string | null;
|
|
3037
|
+
id: string;
|
|
3038
|
+
metadata: Json | null;
|
|
3039
|
+
milestone_id: string | null;
|
|
3040
|
+
name: string;
|
|
3041
|
+
organization_id: string;
|
|
3042
|
+
parent_task_id: string | null;
|
|
3043
|
+
project_id: string;
|
|
3044
|
+
resume_context: Json | null;
|
|
3045
|
+
status: string;
|
|
3046
|
+
type: string;
|
|
3047
|
+
updated_at: string;
|
|
3048
|
+
};
|
|
3049
|
+
Insert: {
|
|
3050
|
+
checklist?: Json;
|
|
3051
|
+
completed_at?: string | null;
|
|
3052
|
+
created_at?: string;
|
|
3053
|
+
description?: string | null;
|
|
3054
|
+
due_date?: string | null;
|
|
3055
|
+
file_url?: string | null;
|
|
3056
|
+
id?: string;
|
|
3057
|
+
metadata?: Json | null;
|
|
3058
|
+
milestone_id?: string | null;
|
|
3059
|
+
name: string;
|
|
3060
|
+
organization_id: string;
|
|
3061
|
+
parent_task_id?: string | null;
|
|
3062
|
+
project_id: string;
|
|
3063
|
+
resume_context?: Json | null;
|
|
3064
|
+
status?: string;
|
|
3065
|
+
type?: string;
|
|
3066
|
+
updated_at?: string;
|
|
3067
|
+
};
|
|
3068
|
+
Update: {
|
|
3069
|
+
checklist?: Json;
|
|
3070
|
+
completed_at?: string | null;
|
|
3071
|
+
created_at?: string;
|
|
3072
|
+
description?: string | null;
|
|
3073
|
+
due_date?: string | null;
|
|
3074
|
+
file_url?: string | null;
|
|
3075
|
+
id?: string;
|
|
3076
|
+
metadata?: Json | null;
|
|
3077
|
+
milestone_id?: string | null;
|
|
3078
|
+
name?: string;
|
|
3079
|
+
organization_id?: string;
|
|
3080
|
+
parent_task_id?: string | null;
|
|
3081
|
+
project_id?: string;
|
|
3082
|
+
resume_context?: Json | null;
|
|
3083
|
+
status?: string;
|
|
3084
|
+
type?: string;
|
|
3085
|
+
updated_at?: string;
|
|
3086
|
+
};
|
|
3087
|
+
Relationships: [
|
|
3088
|
+
{
|
|
3089
|
+
foreignKeyName: "prj_tasks_milestone_id_fkey";
|
|
3090
|
+
columns: ["milestone_id"];
|
|
3091
|
+
isOneToOne: false;
|
|
3092
|
+
referencedRelation: "prj_milestones";
|
|
3093
|
+
referencedColumns: ["id"];
|
|
3094
|
+
},
|
|
3095
|
+
{
|
|
3096
|
+
foreignKeyName: "prj_tasks_organization_id_fkey";
|
|
3097
|
+
columns: ["organization_id"];
|
|
3098
|
+
isOneToOne: false;
|
|
3099
|
+
referencedRelation: "organizations";
|
|
3100
|
+
referencedColumns: ["id"];
|
|
3101
|
+
},
|
|
3102
|
+
{
|
|
3103
|
+
foreignKeyName: "prj_tasks_parent_task_id_fkey";
|
|
3104
|
+
columns: ["parent_task_id"];
|
|
3105
|
+
isOneToOne: false;
|
|
3106
|
+
referencedRelation: "prj_tasks";
|
|
3107
|
+
referencedColumns: ["id"];
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
foreignKeyName: "prj_tasks_project_id_fkey";
|
|
3111
|
+
columns: ["project_id"];
|
|
3112
|
+
isOneToOne: false;
|
|
3113
|
+
referencedRelation: "prj_projects";
|
|
3114
|
+
referencedColumns: ["id"];
|
|
3115
|
+
}
|
|
3116
|
+
];
|
|
3117
|
+
};
|
|
2809
3118
|
session_messages: {
|
|
2810
3119
|
Row: {
|
|
2811
3120
|
created_at: string | null;
|
|
@@ -2996,138 +3305,6 @@ type Database = {
|
|
|
2996
3305
|
}
|
|
2997
3306
|
];
|
|
2998
3307
|
};
|
|
2999
|
-
training_assessments: {
|
|
3000
|
-
Row: {
|
|
3001
|
-
answers: Json | null;
|
|
3002
|
-
assessment_slug: string;
|
|
3003
|
-
attempted_at: string;
|
|
3004
|
-
course_slug: string;
|
|
3005
|
-
id: string;
|
|
3006
|
-
organization_id: string;
|
|
3007
|
-
passed: boolean;
|
|
3008
|
-
score: number;
|
|
3009
|
-
user_id: string;
|
|
3010
|
-
};
|
|
3011
|
-
Insert: {
|
|
3012
|
-
answers?: Json | null;
|
|
3013
|
-
assessment_slug: string;
|
|
3014
|
-
attempted_at?: string;
|
|
3015
|
-
course_slug: string;
|
|
3016
|
-
id?: string;
|
|
3017
|
-
organization_id: string;
|
|
3018
|
-
passed: boolean;
|
|
3019
|
-
score: number;
|
|
3020
|
-
user_id: string;
|
|
3021
|
-
};
|
|
3022
|
-
Update: {
|
|
3023
|
-
answers?: Json | null;
|
|
3024
|
-
assessment_slug?: string;
|
|
3025
|
-
attempted_at?: string;
|
|
3026
|
-
course_slug?: string;
|
|
3027
|
-
id?: string;
|
|
3028
|
-
organization_id?: string;
|
|
3029
|
-
passed?: boolean;
|
|
3030
|
-
score?: number;
|
|
3031
|
-
user_id?: string;
|
|
3032
|
-
};
|
|
3033
|
-
Relationships: [
|
|
3034
|
-
{
|
|
3035
|
-
foreignKeyName: "training_assessments_organization_id_fkey";
|
|
3036
|
-
columns: ["organization_id"];
|
|
3037
|
-
isOneToOne: false;
|
|
3038
|
-
referencedRelation: "organizations";
|
|
3039
|
-
referencedColumns: ["id"];
|
|
3040
|
-
},
|
|
3041
|
-
{
|
|
3042
|
-
foreignKeyName: "training_assessments_user_id_fkey";
|
|
3043
|
-
columns: ["user_id"];
|
|
3044
|
-
isOneToOne: false;
|
|
3045
|
-
referencedRelation: "users";
|
|
3046
|
-
referencedColumns: ["id"];
|
|
3047
|
-
}
|
|
3048
|
-
];
|
|
3049
|
-
};
|
|
3050
|
-
training_certifications: {
|
|
3051
|
-
Row: {
|
|
3052
|
-
awarded_at: string;
|
|
3053
|
-
certification_slug: string;
|
|
3054
|
-
id: string;
|
|
3055
|
-
organization_id: string;
|
|
3056
|
-
user_id: string;
|
|
3057
|
-
};
|
|
3058
|
-
Insert: {
|
|
3059
|
-
awarded_at?: string;
|
|
3060
|
-
certification_slug: string;
|
|
3061
|
-
id?: string;
|
|
3062
|
-
organization_id: string;
|
|
3063
|
-
user_id: string;
|
|
3064
|
-
};
|
|
3065
|
-
Update: {
|
|
3066
|
-
awarded_at?: string;
|
|
3067
|
-
certification_slug?: string;
|
|
3068
|
-
id?: string;
|
|
3069
|
-
organization_id?: string;
|
|
3070
|
-
user_id?: string;
|
|
3071
|
-
};
|
|
3072
|
-
Relationships: [
|
|
3073
|
-
{
|
|
3074
|
-
foreignKeyName: "training_certifications_organization_id_fkey";
|
|
3075
|
-
columns: ["organization_id"];
|
|
3076
|
-
isOneToOne: false;
|
|
3077
|
-
referencedRelation: "organizations";
|
|
3078
|
-
referencedColumns: ["id"];
|
|
3079
|
-
},
|
|
3080
|
-
{
|
|
3081
|
-
foreignKeyName: "training_certifications_user_id_fkey";
|
|
3082
|
-
columns: ["user_id"];
|
|
3083
|
-
isOneToOne: false;
|
|
3084
|
-
referencedRelation: "users";
|
|
3085
|
-
referencedColumns: ["id"];
|
|
3086
|
-
}
|
|
3087
|
-
];
|
|
3088
|
-
};
|
|
3089
|
-
training_progress: {
|
|
3090
|
-
Row: {
|
|
3091
|
-
completed_at: string;
|
|
3092
|
-
course_slug: string;
|
|
3093
|
-
id: string;
|
|
3094
|
-
lesson_slug: string;
|
|
3095
|
-
organization_id: string;
|
|
3096
|
-
user_id: string;
|
|
3097
|
-
};
|
|
3098
|
-
Insert: {
|
|
3099
|
-
completed_at?: string;
|
|
3100
|
-
course_slug: string;
|
|
3101
|
-
id?: string;
|
|
3102
|
-
lesson_slug: string;
|
|
3103
|
-
organization_id: string;
|
|
3104
|
-
user_id: string;
|
|
3105
|
-
};
|
|
3106
|
-
Update: {
|
|
3107
|
-
completed_at?: string;
|
|
3108
|
-
course_slug?: string;
|
|
3109
|
-
id?: string;
|
|
3110
|
-
lesson_slug?: string;
|
|
3111
|
-
organization_id?: string;
|
|
3112
|
-
user_id?: string;
|
|
3113
|
-
};
|
|
3114
|
-
Relationships: [
|
|
3115
|
-
{
|
|
3116
|
-
foreignKeyName: "training_progress_organization_id_fkey";
|
|
3117
|
-
columns: ["organization_id"];
|
|
3118
|
-
isOneToOne: false;
|
|
3119
|
-
referencedRelation: "organizations";
|
|
3120
|
-
referencedColumns: ["id"];
|
|
3121
|
-
},
|
|
3122
|
-
{
|
|
3123
|
-
foreignKeyName: "training_progress_user_id_fkey";
|
|
3124
|
-
columns: ["user_id"];
|
|
3125
|
-
isOneToOne: false;
|
|
3126
|
-
referencedRelation: "users";
|
|
3127
|
-
referencedColumns: ["id"];
|
|
3128
|
-
}
|
|
3129
|
-
];
|
|
3130
|
-
};
|
|
3131
3308
|
users: {
|
|
3132
3309
|
Row: {
|
|
3133
3310
|
config: Json;
|
|
@@ -5405,7 +5582,7 @@ interface ListLeadsResult {
|
|
|
5405
5582
|
* Bulk delete leads parameters
|
|
5406
5583
|
*/
|
|
5407
5584
|
interface BulkDeleteLeadsParams {
|
|
5408
|
-
|
|
5585
|
+
ids?: string[];
|
|
5409
5586
|
campaign_id?: string;
|
|
5410
5587
|
list_id?: string;
|
|
5411
5588
|
limit?: number;
|
|
@@ -7369,12 +7546,16 @@ type ResourceStatus = 'dev' | 'prod';
|
|
|
7369
7546
|
* Organization is derived from the ELEVASIS_PLATFORM_KEY -- not configured here.
|
|
7370
7547
|
*/
|
|
7371
7548
|
interface ElevasConfig {
|
|
7372
|
-
/** Managed by `elevasis-sdk init` and `elevasis-sdk update`. Do not set manually. */
|
|
7373
|
-
templateVersion?: number;
|
|
7374
7549
|
defaultStatus?: ResourceStatus;
|
|
7375
7550
|
dev?: {
|
|
7376
7551
|
port?: number;
|
|
7377
7552
|
};
|
|
7553
|
+
/**
|
|
7554
|
+
* Directory (relative to CWD) to scan for deployable documentation.
|
|
7555
|
+
* Defaults to 'docs'. Use '../docs' when running the SDK from a subdirectory
|
|
7556
|
+
* and wanting to consolidate docs at the project root.
|
|
7557
|
+
*/
|
|
7558
|
+
docsDir?: string;
|
|
7378
7559
|
}
|
|
7379
7560
|
|
|
7380
7561
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elevasis/sdk",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "SDK for building Elevasis organization resources",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -14,10 +14,6 @@
|
|
|
14
14
|
"./worker": {
|
|
15
15
|
"types": "./dist/types/worker/index.d.ts",
|
|
16
16
|
"import": "./dist/worker/index.js"
|
|
17
|
-
},
|
|
18
|
-
"./templates": {
|
|
19
|
-
"types": "./dist/types/templates.d.ts",
|
|
20
|
-
"import": "./dist/templates.js"
|
|
21
17
|
}
|
|
22
18
|
},
|
|
23
19
|
"files": [
|
|
@@ -28,8 +24,6 @@
|
|
|
28
24
|
"dist/types/worker/platform.d.ts",
|
|
29
25
|
"dist/types/worker/adapters/",
|
|
30
26
|
"dist/cli.cjs",
|
|
31
|
-
"dist/templates.js",
|
|
32
|
-
"dist/types/templates.d.ts",
|
|
33
27
|
"reference/"
|
|
34
28
|
],
|
|
35
29
|
"dependencies": {
|
package/reference/_navigation.md
CHANGED
|
@@ -8,7 +8,7 @@ All paths are relative to `node_modules/@elevasis/sdk/reference/`.
|
|
|
8
8
|
|
|
9
9
|
| Resource | Location | Description | When to Load |
|
|
10
10
|
| --- | --- | --- | --- |
|
|
11
|
-
| CLI Reference | `cli.mdx` | Full reference for every elevasis-sdk CLI command --
|
|
11
|
+
| CLI Reference | `cli.mdx` | Full reference for every elevasis-sdk CLI command -- validate, deploy, execute, and inspect resources | Running CLI operations |
|
|
12
12
|
| Concepts Reference | `concepts.mdx` | Plain-English explanations of Elevasis SDK concepts -- glossary, workflow analogies, Zod schemas, execution model, platform tools, common errors, and design decisions | User asks what is or needs conceptual grounding |
|
|
13
13
|
| Getting Started | `getting-started.mdx` | Install the Elevasis SDK, scaffold a project, and run your first deployment | Setting up a new project or onboarding |
|
|
14
14
|
| Elevasis SDK | `index.mdx` | Build and deploy workflows, agents, and resources with the Elevasis SDK | First session or new to the SDK |
|
package/reference/cli.mdx
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: CLI Reference
|
|
3
|
-
description: Full reference for every elevasis-sdk CLI command --
|
|
3
|
+
description: Full reference for every elevasis-sdk CLI command -- validate, deploy, execute, and inspect resources
|
|
4
4
|
loadWhen: "Running CLI operations"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
The `elevasis-sdk` CLI is the primary interface for working with your Elevasis SDK project. Install it as part of `@elevasis/sdk` and use it to
|
|
7
|
+
The `elevasis-sdk` CLI is the primary interface for working with your Elevasis SDK project. Install it as part of `@elevasis/sdk` and use it to validate resource definitions, deploy to the platform, and inspect execution history.
|
|
8
8
|
|
|
9
9
|
**Installation:**
|
|
10
10
|
|
|
@@ -16,117 +16,6 @@ After installation, the `elevasis-sdk` binary is available in your project's `no
|
|
|
16
16
|
|
|
17
17
|
---
|
|
18
18
|
|
|
19
|
-
## elevasis-sdk init
|
|
20
|
-
|
|
21
|
-
Scaffold a new Elevasis SDK project in the specified directory.
|
|
22
|
-
|
|
23
|
-
**Synopsis:**
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
elevasis-sdk init [directory]
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
**Behavior:**
|
|
30
|
-
|
|
31
|
-
- Derives the organization slug from the directory name
|
|
32
|
-
- Checks for file conflicts before writing any files
|
|
33
|
-
- Scaffolds project structure including `src/index.ts`, `elevasis.config.ts`, `package.json`, `tsconfig.json`, and a `CLAUDE.md` with CLI reference and SDK patterns
|
|
34
|
-
- Non-interactive: all values are derived automatically
|
|
35
|
-
|
|
36
|
-
**Flags:**
|
|
37
|
-
|
|
38
|
-
| Flag | Description |
|
|
39
|
-
| ------ | ------------------------------------------------- |
|
|
40
|
-
| (none) | Uses current directory if no argument is provided |
|
|
41
|
-
|
|
42
|
-
**Example:**
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
elevasis-sdk init my-project
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
You can also run `init` without a global install using `pnpm dlx`:
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
pnpm dlx @elevasis/sdk init my-project
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
Scaffolding my-project/...
|
|
56
|
-
|
|
57
|
-
Created 30 files.
|
|
58
|
-
|
|
59
|
-
Next steps:
|
|
60
|
-
cd my-project
|
|
61
|
-
pnpm install
|
|
62
|
-
elevasis-sdk check
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## elevasis-sdk update
|
|
68
|
-
|
|
69
|
-
Update managed project files to the latest template version.
|
|
70
|
-
|
|
71
|
-
**Synopsis:**
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
elevasis-sdk update [--ui]
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
**Behavior:**
|
|
78
|
-
|
|
79
|
-
- Reads `elevasis.config.ts` to get the current `templateVersion` and compares it against the latest template version
|
|
80
|
-
- If already up to date (and no `--ui` flag), exits early with a success message
|
|
81
|
-
- For each managed file:
|
|
82
|
-
- Missing files are written directly
|
|
83
|
-
- `.gitignore` uses append-only merge -- new entries are added, existing entries are never removed
|
|
84
|
-
- `elevasis.config.ts` gets only its `templateVersion` field updated
|
|
85
|
-
- `CLAUDE.md` uses section-aware merge -- SDK-owned sections are replaced with the latest template, user-added sections are preserved
|
|
86
|
-
- All other managed files are compared against the template and flagged for review if they differ
|
|
87
|
-
- Pass `--ui` to scaffold a Vite + React UI app in `ui/` (can be combined with a version update or run independently)
|
|
88
|
-
|
|
89
|
-
**Flags:**
|
|
90
|
-
|
|
91
|
-
| Flag | Description |
|
|
92
|
-
| ------ | --------------------------------------- |
|
|
93
|
-
| `--ui` | Add a Vite + React UI scaffold in `ui/` |
|
|
94
|
-
|
|
95
|
-
**Example output (version update):**
|
|
96
|
-
|
|
97
|
-
```
|
|
98
|
-
$ elevasis-sdk update
|
|
99
|
-
|
|
100
|
-
Updated @elevasis/sdk template v24 -> v27
|
|
101
|
-
|
|
102
|
-
Added:
|
|
103
|
-
.env.example
|
|
104
|
-
|
|
105
|
-
Appended to .gitignore:
|
|
106
|
-
ui/dist
|
|
107
|
-
|
|
108
|
-
Needs agent review:
|
|
109
|
-
tsconfig.json (differs from template)
|
|
110
|
-
|
|
111
|
-
CLAUDE.md sections:
|
|
112
|
-
updated: Commands
|
|
113
|
-
updated: Skills
|
|
114
|
-
preserved: Custom Workflows
|
|
115
|
-
|
|
116
|
-
Run /meta update in Claude Code to merge flagged files.
|
|
117
|
-
Or run /meta fix to verify and repair the full framework.
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
**Example output (already up to date):**
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
$ elevasis-sdk update
|
|
124
|
-
|
|
125
|
-
Project is up to date (template version 27)
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
19
|
## elevasis-sdk check
|
|
131
20
|
|
|
132
21
|
Validate all resource definitions in your project without deploying.
|
|
@@ -107,7 +107,7 @@ The CLI also accepts a `--api-url` flag on every command, which takes priority o
|
|
|
107
107
|
ELEVASIS_PLATFORM_KEY=sk_***
|
|
108
108
|
```
|
|
109
109
|
|
|
110
|
-
Place `.env` in your project root. The CLI
|
|
110
|
+
Place `.env` in your project root. The CLI walks up directories to find it, so running from subdirectories like `operations/` works automatically. Never commit this file.
|
|
111
111
|
|
|
112
112
|
---
|
|
113
113
|
|
|
@@ -179,4 +179,14 @@ Section templates by doc type:
|
|
|
179
179
|
|
|
180
180
|
---
|
|
181
181
|
|
|
182
|
+
## Documentation
|
|
183
|
+
|
|
184
|
+
- [Project Structure](project-structure.mdx) - File-by-file walkthrough of every scaffolded file and its purpose
|
|
185
|
+
- [Agent System](agent.mdx) - CLAUDE.md sections, slash commands, developer profile, and adaptive guidance tiers
|
|
186
|
+
- [Memory System](memory.mdx) - Architecture, error tracking format, scaling rules, and maintenance guidelines
|
|
187
|
+
- [Interaction Guidance](interaction-guidance.mdx) - Dimensional adaptation rules per skill axis with growth tracking protocol
|
|
188
|
+
- [Tutorial System](tutorial-system.mdx) - 21-item tutorial menu, skill-adaptive lesson variants, and progress tracking
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
182
192
|
**Last Updated:** 2026-03-06
|